Skip to content

Latest commit

 

History

History
194 lines (150 loc) · 7.88 KB

CONTRIBUTING.md

File metadata and controls

194 lines (150 loc) · 7.88 KB
Raw

CONTRIBUTING

AstroCommunity install for contributors

If you wish to contribute to AstroCommunity, you should:

  1. create a fork on GitHub
  2. clone your fork to your machine (lazy.nvim automatically uses the ~/project folder for development of plugins, this can be configured in lazy.nvim)
  • For ssh: 
    $ git clone [email protected]:<YOUR GITHUB USERNAME>/astrocommunity.git ~/projects/astrocommunity
  • For https: 
    $ git clone https://github.com/<YOUR GITHUB USERNAME>/astrocommunity.git ~/projects/astrocommunity

  1. add a new remote repo to track

    • this means you can push/pull as normal to your own repo, but also easily track & update from the AstroCommunity repo
    • for ssh: 
      $ git remote add upstream [email protected]:AstroNvim/astrocommunity.git
    • for https: 
      $ git remote add upstream https://github.com/AstroNvim/astrocommunity.git

  2. any time you create a branch to do some work, use

    $ git fetch upstream && git checkout -b dev-myFEAT upstream/main

  3. only use the --rebase flag to update your dev branch

    • this means that there are no Merge astrocommunity/main into devBranch commits, which are to be avoided
    $ git pull upstream --rebase

  4. setup your AstroNvim to tell the Lazy package manager to use your local clone of AstroCommunity. This can be done a couple different ways (these are added to your plugins specification table):

    • specifying the entire path that you cloned the repo to 
      { dir = "/path/to/astrocommunity" },
    • with the dev feature which by default looks in the ~/projects folder: 
      { "AstroNvim/astrocommunity", dev = true },

Things to know before contributing

  • When making a PR (pull request), please be very descriptive about what you've done!

  • Pull request titles must follow Conventional Commits Specification

    • We use an only squash and merge development cycle here, so please open PRs that make sense to be represented in the git history in a single commit message

    • PR titles should be formatted with 'fix', 'feat', 'docs', 'refactor', or 'chore'. ex: feat(<scope>): add new plugin

    • If your contribution contains any sort of breaking change include a ! at the end of the change type. ex: feat(<scope>)!: move status bar from lualine to feline

    • PR titles should include the given scope of the project that is modified. This should be the name of the pre-existing directory in the project before the PR. For example:

      • If you are adding a new plugin, the scope would be the name of the category it is being added into. ex. feat(utility): added noice.nvim plugin

      • If you are modifying a pre-existing plugin or pack, the scope would be the name of the plugin folder. ex. fix(noice-nvim): fix LSP handler error

  • PRs should follow the pull request formats where applicable

  • When adding a new plugin, we are trying our best to use categories as used by NeovimCraft. Please check there to see if your plugin exists and use the category they use. If there the plugin isn't available use the best fit category and we can discuss the organization on the pull request.

  • When adding a new plugin, please add any notes/caveats that the user should be aware of inside the accompanying README.md file. Notes and caveats could include:

    • Example of a useful LSP config for a language pack.
    • The plugins being used in the pack doesn't support a specific SDK/Version of that language.

How to remove, squash, or edit commits from your PR

You may have been directed here to remove a commit such as a merge commit: Merge astrocommunity/main into devBranch from your PR

As these commands edit your git history, you may need to force push with git push origin --force-with-lease

  1. Run the following:
$ git rebase -i HEAD~<NUMBER OF COMMITS TO GO BACK>
Example 

$ git rebase -i HEAD~4
pick 28b2dcb feat: statusline add lsp status
pick dad9a39 fix: typo
pick 68f72f1 add clickable btn for exiting nvim
pick b281b53 avoid using q! for quitting vim

# Rebase 52b655b..b281b53 onto 52b655b (4 commands)
#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) using shell
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
# .       create a merge commit using the original merge commit's
# .       message (or the oneline, if no original merge commit was
# .       specified). Use -c <commit> to reword the commit message.
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

  1. Change the pick commands to whatever you wish, you may wish to s squash, d drop or e edit a commit. Then save & quit this git file to run it.
Example 

pick 28b2dcb feat: statusline add lsp status
squash dad9a39 fix: typo
edit 68f72f1 add clickable btn for exiting nvim
d b281b53 avoid using q! for quitting vim

# Rebase 52b655b..b281b53 onto 52b655b (4 commands)
#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) using shell
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
# .       create a merge commit using the original merge commit's
# .       message (or the oneline, if no original merge commit was
# .       specified). Use -c <commit> to reword the commit message.
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

  1. If you picked drop you are done. If you picked squash then you will be brought to a screen to update the commit message for the new aggregated commit, please make sure the new commit message follows the Conventional Commit specification. If you picked edit then edit your files, then run:
$ git add <files>
  1. Continue rebasing until all edits are finished. Run the following command to continue through the rebase if there are more changes:
$ git rebase --continue
  1. Push the changes with --force-with-lease:
$ git push origin --force-with-lease

Help

For help with contributing and anything else AstroNvim related join the discord