diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e998cdf0..f193542d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,11 +155,11 @@ See the [exe readme](./exe/README.md). ## Follow MATLAB style guidelines -Please follow the style introduced in [MATLAB Guidelines 2.0, Richard Johnson](http://cnl.sogang.ac.kr/cnlab/lectures/programming/matlab/Richard_Johnson-MatlabStyle2_book.pdf). +When you are introducing new changes to the codes, please follow the style introduced in [MATLAB Guidelines 2.0, Richard Johnson](http://cnl.sogang.ac.kr/cnlab/lectures/programming/matlab/Richard_Johnson-MatlabStyle2_book.pdf). -When making a pull request, the code is [checked](https://github.com/EcoExtreML/STEMMUS_SCOPE/actions/workflows/lint.yml) by the [MISS_HIT](misshit.org/) linter and style checker. -Any PR needs to pass this check before merging. -MISS_HIT is configured in `miss_hit.cfg`. +When you submit a pull request, the code is also [checked](https://github.com/EcoExtreML/STEMMUS_SCOPE/actions/workflows/lint.yml) by the [MISS_HIT](misshit.org/) linter and style checker. +The status of `MISS_HIT` checks is shown below the pull request. The checks should be successful (green) before merging the pull request. +MISS_HIT is configured in [`miss_hit.cfg`](./miss_hit.cfg). For more details see the following instructions:
Installation instructions diff --git a/pull_request_template.md b/pull_request_template.md index 5611aa9a..0e605ef5 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -9,6 +9,6 @@ Please re-generate exe file if matlab codes are changed. About how to create an - [ ] @mentions of the person or team responsible for reviewing proposed changes. - [ ] This pull request has a descriptive title. - [ ] Code is written according to the [guidelines](http://cnl.sogang.ac.kr/cnlab/lectures/programming/matlab/Richard_Johnson-MatlabStyle2_book.pdf). -- [ ] The code complies with the [MISS_HIT style checker and linter](https://github.com/EcoExtreML/STEMMUS_SCOPE/blob/main/CONTRIBUTING.md#follow-matlab-style-guidelines) +- [ ] The checks by [MISS_HIT style checker and linter](https://github.com/EcoExtreML/STEMMUS_SCOPE/blob/main/CONTRIBUTING.md#follow-matlab-style-guidelines), below the pull request, are successful (green). - [ ] Documentation is available. - [ ] Model runs successfully.