Skip to content

Commit

Permalink
Apply Sarah's suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: SarahAlidoost <[email protected]>
  • Loading branch information
BSchilperoort and SarahAlidoost committed Apr 12, 2023
1 parent b904260 commit 88ba758
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
<details><summary>Installation instructions</summary>
Expand Down
2 changes: 1 addition & 1 deletion pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 88ba758

Please sign in to comment.