Skip to content

Commit 8c55ef7

Browse files
authored
Fix typos in Contributing.md (#2204)
1 parent 7cc1c93 commit 8c55ef7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/src/Contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ We provide a brief [git tutorial](https://github.com/CliMA/ClimaWorkshops/blob/m
7070
### General coding guidelines
7171
1. Keep the number of members of Julia structs small if possible (less than 8 members).
7272
2. Code should reflect "human intuition" if possible. This mean abstraction should reflect how humans reason about the problem under consideration.
73-
3. Code with small blast radius. If your code needs to be modified or extendended, the resulting required changes should be as small and as localized as possible.
73+
3. Code with small blast radius. If your code needs to be modified or extended, the resulting required changes should be as small and as localized as possible.
7474
4. When you write code, write it with testing and debugging in mind.
7575
5. Ideally, the lowest level structs have no defaults for their member fields. Nobody can remember all the defaults, so it is better to introduce them at the high-level API only.
7676
6. Make sure that module imports are specific so that it is easy to trace back where functions that are used inside a module are coming from.
@@ -175,7 +175,7 @@ do not require the unit tests to be run.
175175
### Integration testing
176176

177177
Currently a number of checks are run during integration testing before being
178-
merged into master.
178+
merged into `main`.
179179

180180
- `JuliaFormatter` checks if the PR is formatted with `.dev/climaformat.jl`.
181181
- `Documentation` checks that the documentation correctly builds for the merged PR.
@@ -200,7 +200,7 @@ $CLIMACORE_HOME/docs/src
200200
```
201201
And [Literate.jl](https://fredrikekre.github.io/Literate.jl/v2/) tutorials:
202202
```
203-
$$CLIMACORE_HOME/tutorials
203+
$CLIMACORE_HOME/tutorials
204204
```
205205

206206
To locally build the documentation you need to create a new `docs` project

0 commit comments

Comments
 (0)