So you want to help with the development of Trébol? Thanks so much! 💖
Please follow guidance as described in this file. These are not mandatory rules, but if you want your contributions to be accepted eagerly, it is better to follow them as good as you can.
If you have any questions, don't hesitate to contact @bglamadrid (me) for it.
- Find issues that need work. Please read Working on Issues before proceeding.
- Submit new issues in the form of bug reports, feature requests or improvements.
- Find questions that need answers. Engage and discuss things about the software/project. Fresh and new perspectives can always be useful.
- Ask new questions you may have. Others may share the same doubts, thus being able to find answers here would be of great help.
- Improve existing documentation.
- This project mostly relies on JavaDoc for now, and it may need polishing.
- You can also help improve these contribution guidelines.
- Before attempting to submit new issues, please search to make sure it hasn't been raised before. You can totally comment on closed issues if you think something has been, or needs to be, brought up again.
- Details are always encouraged and appreciated. So is proper text format; make the most you can of Markdown!
- If you want to work on an issue, please request that it is assigned to you beforehand.
- If for any reason at all you decide to stop
or find yourself unable to work on the issue anymore, please let me know.
- I may be requesting updates if an issue gets stalled for too long, and eventually leave them unassigned if no feedback is provided.
- Please use the GitHub web interface; we have a template set up for you to accurately describe your PR.
- You don't have to follow it by-the-book... But it helps everybody to give proper, well-deserved structure and description to changes in code, and PRs are great units to do exactly that.