forked from NotAShelf/nvf
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c51b719
commit 48e0caf
Showing
550 changed files
with
20,969 additions
and
9,405 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,23 +8,42 @@ | |
|
||
## Welcome | ||
|
||
I'm glad you are thinking about contributing to neovim-flake! If you're unsure about anything, just ask - or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. Friendly contributions are always welcome. | ||
I'm glad you are thinking about contributing to nvf! If you're unsure about | ||
anything, just ask - or submit the issue or pull request anyway. The worst that | ||
can happen is you'll be politely asked to change something. Friendly | ||
contributions are always welcome. | ||
|
||
Before you contribute, I encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). | ||
Before you contribute, I encourage you to read this project's CONTRIBUTING | ||
policy (you are here) and its [LICENSE](../LICENSE) to understand how your | ||
contributions are licensed. | ||
|
||
If you have any questions regarding those files, feel free to open an issue or [shoot me an email](mailto:[email protected]). Discussions tab is also available for more informal discussions. | ||
If you have any questions regarding those files, feel free to open an issue or | ||
[shoot me an email](mailto:[email protected]). Discussions tab is also available | ||
for more informal discussions. | ||
|
||
## Contributing | ||
|
||
The contribution process is mostly documented in the [pull request template](.github/pull_request_template.md). You will find a checklist of items to complete before submitting a pull request. Please make sure you complete it before submitting a pull request. If you are unsure about any of the items, please ask. | ||
The contribution process is mostly documented in the | ||
[pull request template](PULL_REQUEST_TEMPLATE/pull_request_template.md). You | ||
will find a checklist of items to complete before submitting a pull request. | ||
Please make sure you complete it before submitting a pull request. If you are | ||
unsure about any of the items, please ask. | ||
|
||
### Guidelines | ||
|
||
We provide instructions on a healthy contribution to neovim-flake - including styling, commit formats, how-to guides for adding new modules and options. | ||
You are very well recommended to read the contributing guideliner over at [the documentation](https://notashelf.github.io/neovim-flake#hacking) | ||
We provide instructions on a healthy contribution to neovim-flake - including | ||
styling, commit formats, how-to guides for adding new modules and options. You | ||
are very well recommended to read the contributing guidelines over at | ||
[the documentation](https://notashelf.github.io/nvf#hacking) | ||
|
||
### Code of Conduct | ||
|
||
This project does not quite have a code of conduct yet. And to be honest, I'm not sure if I want one or if it will ever have one. I'm not expecting this project to be a hotbed of activity, but I do want to make sure that everyone who does contribute feels welcome and safe. As such, I will do my best to make sure that those who distrupt the project are dealt with swiftly and appropriately. | ||
This project does not quite have a code of conduct yet. And to be perfectly | ||
honest, I'm not sure if I want one or if it will ever have one. I'm not | ||
expecting this project to be a hotbed of activity, but I do want to make sure | ||
that everyone who does contribute feels welcome and safe. As such, I will do my | ||
best to make sure that those who distrupt the project are dealt with swiftly and | ||
appropriately. | ||
|
||
If you feel that you are not being treated with respect, please contact me directly. | ||
If you feel that you are not being treated with respect, please contact me | ||
directly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
github: NotAShelf | ||
ko_fi: NotAShelf | ||
liberapay: NotAShelf | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,57 @@ | ||
# Description | ||
|
||
A clear and concise description of the aim of your Pull Request. | ||
|
||
**If your pull request aims to fix an open issue or a present bug, please link the relevant issue below. If not, please remove this section** | ||
Fixes #(issue) | ||
|
||
## Type of change | ||
|
||
Please delete any options that are not relevant. | ||
|
||
- Bug fix (non-breaking change which fixes an issue) | ||
- New feature (non-breaking change which adds functionality) | ||
- Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- Translation/Language update | ||
- Docs | ||
- Other | ||
|
||
## Checklist | ||
|
||
Please try to check at least a majority of the checklist before opening your pull request. Exceptions to this will be reviewed on a case by case basis. | ||
|
||
- [ ] My code follows the style and contributing guidelines of this project. | ||
- [ ] I ran Alejandra to format my code (`nix fmt`). | ||
- [ ] I have performed a self-review of my own code and tested it. | ||
- [ ] I have commented my code, particularly in hard-to-understand areas. | ||
- [ ] My changes generate no new warnings. | ||
- [ ] This change requires a documentation update. | ||
- [ ] I have updated the documentation accordingly. | ||
|
||
## Screenshots & Logs | ||
|
||
You are kindly requested to attach screenshots of your changes in actions and preferably your build/run logs for all available packages. If you are not sure how to do this, you can refer to the [documentation](https://notashelf.github.io/neovim-flake/). | ||
|
||
**Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.** | ||
|
||
```console | ||
# Paste your logs here | ||
``` | ||
<!-- | ||
^ Please include a clear and concise description of the aim of your Pull Request above this line ^ | ||
For plugin dependency/module additions, please make sure to link the source link of the added plugin | ||
or dependency in this section. | ||
If your pull request aims to fix an open issue or a please bug, please also link the relevant issue | ||
below this line. You may attach an issue to your pull request with `Fixes #<issue number>` outside | ||
this comment, and it will be closed when your pull request is merged. | ||
--> | ||
|
||
## Sanity Checking | ||
|
||
<!-- | ||
Please check all that apply. As before, this section is not a hard requirement but checklists with more checked | ||
items are likely to be merged faster. You may save some time in maintainer review by performing self-reviews here | ||
before submitting your pull request. | ||
If your pull request includes any change or unexpected behaviour not covered below, please do make sure to include | ||
it above in your description. | ||
--> | ||
|
||
[editorconfig]: https://editorconfig.org | ||
[changelog]: https://github.com/NotAShelf/nvf/tree/main/docs/release-notes | ||
|
||
- [ ] I have updated the [changelog] as per my changes | ||
- [ ] I have tested, and self-reviewed my code | ||
- Style and consistency | ||
- [ ] I ran **Alejandra** to format my code (`nix fmt`) | ||
- [ ] My code conforms to the [editorconfig] configuration of the project | ||
- [ ] My changes are consistent with the rest of the codebase | ||
- If new changes are particularly complex: | ||
- [ ] My code includes comments in particularly complex areas | ||
- [ ] I have added a section in the manual | ||
- [ ] _(For breaking changes)_ I have included a migration guide | ||
- Package(s) built: | ||
- [ ] `.#nix` (default package) | ||
- [ ] `.#maximal` | ||
- [ ] `.#docs-html` (manual, must build) | ||
- Tested on platform(s) | ||
- [ ] `x86_64-linux` | ||
- [ ] `aarch64-linux` | ||
- [ ] `x86_64-darwin` | ||
- [ ] `aarch64-darwin` | ||
|
||
<!-- | ||
If your changes touch upon a portion of the codebase that you do not understand well, please make sure to consult | ||
the maintainers on your changes. In most cases, making an issue before creating your PR will help you avoid duplicate | ||
efforts in the long run. | ||
--> | ||
|
||
--- | ||
|
||
Add a :+1: [reaction] to [pull requests you find important]. | ||
|
||
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ | ||
[pull requests you find important]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc |
Oops, something went wrong.