From f86f8bb9dc0a24b1a97a4882959c09851cd7f75f Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Tue, 26 Nov 2024 11:00:42 +0300 Subject: [PATCH] meta: update CONTRIBUTING and pull request tempalte --- .github/CONTRIBUTING.md | 35 ++++++++++++++----- .../pull_request_template.md | 18 +++++----- 2 files changed, 36 insertions(+), 17 deletions(-) rename .github/{ => PULL_REQUEST_TEMPLATE}/pull_request_template.md (83%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d85c28da..a43a9445 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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:me@notashelf.dev). 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:me@notashelf.dev). Discussions tab is also available +for more informal discussions. ## Contributing -The contribution process is mostly documented in the [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. +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. diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md similarity index 83% rename from .github/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 7768d36e..b2a26919 100644 --- a/.github/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -6,7 +6,7 @@ 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 #` outside -this comment. +this comment, and it will be closed when your pull request is merged. --> ## Sanity Checking @@ -23,20 +23,20 @@ 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. +- [ ] 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. + - [ ] 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. + - [ ] 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` + - [ ] `.#docs-html` (manual, must build) - Tested on platform(s) - [ ] `x86_64-linux` - [ ] `aarch64-linux`