2023-02-16 20:51:15 +01:00
|
|
|
# Contribution Guidelines
|
|
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
|
|
|
|
- [Welcome](#welcome)
|
|
|
|
|
- [Contributing](#contributing)
|
|
|
|
|
- [Code of Conduct](#code-of-conduct)
|
|
|
|
|
|
|
|
|
|
## Welcome
|
2023-02-16 20:47:55 +01:00
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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.
|
2023-02-16 20:47:55 +01:00
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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.
|
2023-02-16 20:47:55 +01:00
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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.
|
2023-02-16 20:47:55 +01:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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.
|
2023-02-16 20:47:55 +01:00
|
|
|
|
2023-06-05 20:36:43 +02:00
|
|
|
### Guidelines
|
|
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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)
|
2023-05-03 15:03:14 +02:00
|
|
|
|
2023-10-01 15:09:41 +02:00
|
|
|
### Code of Conduct
|
2023-05-03 15:03:14 +02:00
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
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.
|
2023-05-03 15:03:14 +02:00
|
|
|
|
2024-11-26 09:00:42 +01:00
|
|
|
If you feel that you are not being treated with respect, please contact me
|
|
|
|
|
directly.
|
