diff options
92 files changed, 6059 insertions, 2782 deletions
diff --git a/nvim/.config/nvim/.github/CODE_OF_CONDUCT.md b/nvim/.config/nvim/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..86a3913 --- /dev/null +++ b/nvim/.config/nvim/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at {{ email }}. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + diff --git a/nvim/.config/nvim/.github/CONTRIBUTING.md b/nvim/.config/nvim/.github/CONTRIBUTING.md new file mode 100644 index 0000000..fff45e3 --- /dev/null +++ b/nvim/.config/nvim/.github/CONTRIBUTING.md @@ -0,0 +1,170 @@ +# CONTRIBUTING + +## AstroNvim install for contributors + +If you wish to contribute to AstroNvim, you should: +1. [create a fork on GitHub](https://docs.github.com/en/get-started/quickstart/fork-a-repo) +2. clone your fork to your machine + - For ssh: + ```shell + $ git clone git@github.com:<YOUR GITHUB USERNAME>/AstroNvim.git ~/.config/nvim + ``` + - For https: + ```shell + $ git clone https://github.com/<YOUR GITHUB USERNAME>/AstroNvim.git ~/.config/nvim + ``` +3. [add a new remote repo to track](https://www.atlassian.com/git/tutorials/git-forks-and-upstreams) + - this means you can push/pull as normal to your own repo, but also easily track & update from the AstroNvim repo + - for ssh: + ```shell + $ git remote add upstream git@github.com:AstroNvim/AstroNvim.git + ``` + - for https: + ```shell + $ git remote add upstream https://github.com/AstroNvim/AstroNvim.git + ``` +4. any time you create a branch to do some work, use + ```shell + $ git fetch upstream && git checkout -b dev-myFEAT upstream/main + ``` +5. only use the **--rebase** flag to update your dev branch + - this means that there are no `Merge AstroNvim/main into devBranch` commits, which are to be avoided + ```shell + $ git pull upstream --rebase + ``` + +## Things to know before contributing + +- Development happens on the `nightly` branch, so please make sure of a couple things + + - all branches are rebased on the `nightly` branch to get the latest updates. + + - all pull requests are made to merge into `nightly` + +- When making a PR (pull request), please be very descriptive about what you've done! + +- Commit messages must follow [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) + + - PR titles and commit messages should be formatted with 'fix', 'feat', 'docs', 'refactor', or 'chore'. ex: `feat: add new plugin` + + - If your contribution mostly pertains to a single module in AstroNvim, please include that in the title. ex: If you have modified something in the `lua/configs/lsp` folder for the lsp configuration use something like `fix(lsp): typo in lsp mappings` + + - If your contribution contains any sort of breaking change include a `!` at the end of the change type. ex: `feat!: move status bar from lualine to feline` + +- PRs should follow the pull request formats where applicable + +- We are open to all PRs, but if a PR is denied for any reason please don't be discouraged! We'll still be open to discussions. If you have any questions before opening the PR feel free to join the [discord server](https://discord.gg/UcZutyeaFW). + +- AstroNvim aims to provide the best user experience when it comes to being able to support confident updating for users, for this reason please avoid opening PRs with breaking changes. Avoiding breaking changes is not always going to be possible, so if you think it is completely necessary we are open to discussion. + +## 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 AstroNvim/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> + ``` + <details><summary>Example</summary> + <p> + + ```shell + $ git rebase -i HEAD~4 + ``` + + ```shell + 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 + ``` + + </p> + </details> + +2. 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. + + <details><summary>Example</summary> + <p> + + ```shell {3,4} + 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 |