mirror of
https://github.com/hzrd149/nostrudel.git
synced 2025-03-17 13:21:44 +01:00
add contributing guide
This commit is contained in:
parent
ccd26b0092
commit
5039f1ffad
28
CONTRIBUTING.md
Normal file
28
CONTRIBUTING.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for considering contributing to the project! I welcome contributions from everyone.
|
||||
|
||||
**NOTE: If you are looking to open a PR, please fork off of the `next` branch since that has the latest changes**
|
||||
|
||||
## How to contribute
|
||||
|
||||
- Fork the repo
|
||||
- Checkout the `next` branch `git checkout next`
|
||||
- Create a new branch for your feature `git checkout -b new-feature`
|
||||
- Start making changes and fixing things
|
||||
- Open a pull request [here](https://github.com/hzrd149/nostrudel/pulls)
|
||||
- Wait for feedback. it might take me a while to look at it
|
||||
|
||||
## Guidelines
|
||||
|
||||
- All code if formatted with prettier. you can run `yarn run format` to format the project
|
||||
- Write clear and concise commit messages
|
||||
|
||||
## Issues and Bug Reports
|
||||
|
||||
If you find a bug or have an idea for a new feature, please create an issue in our repository.
|
||||
Be sure to include a clear description of the problem or feature request, and what version you found the bug in. (either `nostrudel.ninja` or `next.nostrudel.ninja`)
|
||||
|
||||
## License
|
||||
|
||||
By contributing to this project, you agree that your contributions will be licensed under the project's [license](./LICENSE).
|
Loading…
x
Reference in New Issue
Block a user