nostrudel/CONTRIBUTING.md

29 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-05-09 18:25:06 -05:00
# Contributing
Thank you for considering contributing to the project! I welcome contributions from everyone.
2025-02-13 13:01:29 -06:00
**NOTE: If you are looking to open a PR, please fork off of the `master` branch since that has the latest changes**
2024-05-09 18:25:06 -05:00
## How to contribute
- Fork the repo
2025-02-13 13:01:29 -06:00
- Checkout the `master` branch `git checkout master`
2024-05-09 18:25:06 -05:00
- 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 `pnpm run format` to format the project
2024-05-09 18:25:06 -05:00
- 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).