Updated Development (markdown)

Alex Ling 2020-07-19 22:03:38 +08:00
parent 079bd373d8
commit 5a5d2e20f4
1 changed files with 1 additions and 0 deletions

@ -8,6 +8,7 @@ The `master` branch contains source code for the latest stable release. In will
1. Fork this repository to your own account 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` 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. Run `make setup` to set up the development environment. Now you are ready to develop Mango!
3. Please write unit tests for your Crytal code if possible. The test files are in the `spec/` directory 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 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 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