Skip to content

Commit d351007

Browse files
authored
Refactor CONTRIBUTING.md (#108)
1 parent ce50712 commit d351007

File tree

2 files changed

+32
-13
lines changed

2 files changed

+32
-13
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to RQADeforestation.jl
2+
3+
First off, thanks for taking the time to contribute!
4+
This file collects important information for local development of the package.
5+
6+
## Local setup
7+
8+
Install `just` into your system, following its README [installation instructions](https://github.com/casey/just?tab=readme-ov-file#installation).
9+
10+
Then run
11+
12+
```bash
13+
just init
14+
```
15+
16+
This will for instance setup pre-commit to enforce the standard Julia styling [blue](https://github.com/JuliaDiff/BlueStyle).
17+
18+
## Issues
19+
20+
We use [GitHub issue tracker](https://github.com/EarthyScience/RQADeforestation.jl/issues).
21+
Pull Requests to the [origin main branch](https://github.com/EarthyScience/RQADeforestation.jl) are always welcome!
22+
23+
## Tests
24+
25+
Tests entrypoint is the [test directory](test).
26+
We use [TestItemRunner](https://github.com/julia-vscode/TestItemRunner.jl) for unit tests.
27+
28+
## Documentation
29+
30+
We use [Documenter](https://documenter.juliadocs.org/stable/) to document the individual Julia functions.
31+
See the [docs directory](docs) for further details.
32+
In addition, we document the entire umbrella project [here](https://earthyscience.github.io/FAIRSenDD/).

README_DEVELOPER.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)