Skip to content

Commit 271d836

Browse files
committed
polish docs
1 parent d0e3779 commit 271d836

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> NOTE: The instructions below are meant for users who want to add changes to
44
the model source code. If you want to run the model, see the documentation on
5-
`Running the model`.
5+
["**Running the model**"](./run_model.md).
66

77
This repository includes the MATLAB source code of the STEMMUS-SCOPE model. We welcome any
88
kind of contributions to our software, from simple comments or questions to a full
@@ -151,7 +151,7 @@ To know about the most common Git commands, follow the guides
151151
## Adding changes to the model source code
152152

153153
To setup the required software and configurations, see the documentation on
154-
`Getting started`.
154+
["**Getting started**"](./getting_started.md).
155155

156156
It would be ideal to introduce changes incrementally over time. This way, you
157157
can track the changes and understand the impact of each change. Here are the
@@ -209,7 +209,7 @@ When you are reviewing a pull request, you should follow the steps below:
209209
When you are merging a pull request, you should follow the steps below:
210210

211211
- Make sure the pull request is approved by at least one reviewer.
212-
- Make sure all the items in the pull requests list are checked.
212+
- Make sure all the items in the pull request's list are checked.
213213

214214
## Creating an executable file of STEMMUS_SCOPE
215215

@@ -292,20 +292,22 @@ browser.
292292

293293
When you are ready to make a release of the model, follow the steps below:
294294

295-
- Make sure all new changes are added to changes log in the [`CHANGELOG.md`
296-
file](https://github.com/EcoExtreML/STEMMUS_SCOPE/blob/main/CHANGELOG.md).
295+
- Make sure all new changes are added to changes log in the file
296+
["CHANGELOG.md"](https://github.com/EcoExtreML/STEMMUS_SCOPE/blob/main/CHANGELOG.md).
297297
- Create a new release in the repository. The release should have a version number
298298
following the [semantic versioning](https://semver.org/) guidelines.
299299
- Add a description of the changes in the release notes.
300300

301301
## GitHub actions workflow
302302

303-
GitHub actions workflows are located in the folder `.github/workflows`:
303+
[GitHub
304+
actions](https://docs.github.com/en/actions/about-github-actions/understanding-github-actions)
305+
workflows are located in the folder `.github/workflows`:
304306

305307
- `lint.yml`: This workflow checks the code style and lints the code using
306308
`MISS_HIT`.
307309
- `doc_deploy.yml`: This workflow builds the documentation and deploys it to
308-
GitHub pages.
310+
GitHub pages. It will create a gh-pages branch in the repository.
309311
- `publish-container`: This workflow builds the docker image and publishes it to
310312
the repository once a new release is made. The docker image will avialable in
311313
the
@@ -322,7 +324,7 @@ workflow](#github-actions-workflow). To build and run the docker image locally,
322324
follow the steps below:
323325

324326
- Install [Docker](https://www.docker.com/).
325-
- Build the docker image as:
327+
- Build the docker image **locally** as:
326328

327329
```bash
328330
cd STEMMUS_SCOPE
@@ -345,4 +347,4 @@ follow the steps below:
345347

346348
## Octave compatibility
347349

348-
See the documentation on [Octave compatibility](./Octave_instructions.md).
350+
See the documentation on [Octave](./Octave_instructions.md).

docs/run_model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#
22

33
> NOTE: The instructions below are meant for users who want to run the model. If
4-
you want to add changes to the model, see the documentation on `Contributing
5-
guide`.
4+
you want to add changes to the model, see the documentation on ["**Contributing
5+
guide**"](./CONTRIBUTING.md).
66

77
## Workflow of STEMMUS_SCOPE
88

0 commit comments

Comments
 (0)