Rooba
/
Mango
mirror of https://github.com/getmango/Mango.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add development page

Alex Ling 2020-05-24 13:34:09 +08:00
parent 5471d6bc52
commit 599a3d7f2f
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Development.md Normal file

@ -0,0 +1,12 @@
First of all, thank you for your interest in contributing to Mango! To make sure your PR can be reviewed and merged smoothly, please read the following development guideline.
General workflow
1. Fork this repository to your own account
2. Create a new branch from **the `dev` branch**. If you are developing a new feature, please name your branch `feature/your-new-feature`. If you are working on a bug fix, please name it `fix/your-bug-fix`
3. Please write unit tests for your Crytal code if possible. The test files are in the `spec/` directory
4. Please run `make test` (unit testing) and `make check` (linter and static analyzer) before submitting your PR
5. When you are done, submit a PR to merge it to **the `dev` branch** in the main repository. Your code will be reviewed and we may ask you to make further changes
6. The `dev` branch will be merged to the `master` branch when we are making a new release
If you need help, feel free to reach out to us in [gitter](https://gitter.im/mango-cr/mango). Happy hacking!