Skip to content

Commit c170031

Browse files
committed
Add contributing info to README
1 parent 8e2cbfd commit c170031

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
11
# Open Source Geospatial Workflows in the Cloud
22

33
Learn about Tools and Techniques for Data Access, Analysis, Visualization, Storytelling, and Sharing in the Python and Jupyter ecosystem
4+
5+
6+
## Contributing
7+
8+
This repository uses [`pixi`](https://pixi.sh) (at least for now) for managing
9+
dependencies and tasks.
10+
To start up a website preview server, run `pixi run preview`.
11+
12+
13+
### Checks
14+
15+
This repository uses [`pre-commit`](https://pre-commit.com/) for quality checks.
16+
To initialize `pre-commit` on this repo:
17+
18+
```
19+
pre-commit install
20+
```
21+
22+
You only need to do this once!
23+
24+
25+
### Previewing
26+
27+
```
28+
pixi run preview
29+
```
30+
31+
32+
### Writing: quality, voice, style, formatting, andragogy, ?
33+
34+
Reference [diataxis](https://diataxis.fr/) for quality guidance.
35+
36+
Understand your audience. Which of the
37+
[four kinds of documentation](https://diataxis.fr/start-here/#the-four-kinds-of-documentation)
38+
are you writing?
39+
40+
* [Learning-oriented tutorial](https://diataxis.fr/tutorials/)
41+
* [Understanding-oriented explanation](https://diataxis.fr/explanation/)

0 commit comments

Comments
 (0)