File tree Expand file tree Collapse file tree 2 files changed +32
-13
lines changed
Expand file tree Collapse file tree 2 files changed +32
-13
lines changed Original file line number Diff line number Diff line change 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/ ) .
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments