jan/CONTRIBUTING.md
2023-08-30 16:55:27 +07:00

32 lines
929 B
Markdown

# Contributing to jan
First off, thank you for considering contributing to jan. It's people like you that make jan such an amazing project.
## How Can I Contribute?
### Reporting Bugs
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/janhq/jan/issues).
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/janhq/jan/issues/new).
### Suggesting Enhancements
- Open a new issue with a clear title and description.
### Your First Code Contribution
- Fork the repo.
- Create a new branch (`git checkout -b feature-name`).
- Commit your changes (`git commit -am 'Add some feature'`).
- Push to the branch (`git push origin feature-name`).
- Open a new Pull Request.
## Styleguides
### Git Commit Messages
- Use the present tense ("Add feature" not "Added feature").
## Additional Notes
Thank you for contributing to jan!