First of all, thank you for considering contributing to Chai Builder!
We welcome any type of contribution, not only code. Like for example:
- QA: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
- Marketing: writing blog posts, howto's, tutorials, etc.
- Community: presenting the project at meetups, organizing a dedicated meetup for the local community, etc.
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
Any code change should be submitted as a pull request. Before start working on something make always a search in opened issues and pull requests, this might help you to avoid wasting time.
A pull request could be a bug fix, new feature and much more, but in all cases, open a new issue and talk about what you want to do. Often happens to work on something already fixed (ready to release) or in progress.
The title should be brief but comprehensive, the description contains a link to the opened issue and the proposed solution. The pull request should contain tests whenever possible. Keep in mind that the bigger is the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
The code is auto formatted with prettier on any commit, therefore you can write in any style you prefer
If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!).