Skip to content

Commit 643dd4e

Browse files
committed
docs: Add contribution guidelines
1 parent a593163 commit 643dd4e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/Developers/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
# Contributing
22

3+
We welcome pull-requests.
4+
5+
For larger contributions, please open an issue describing your idea. It
6+
may provide valuable discussion and feedback. It also prevents the unfortunate
7+
case of two persons working on the same thing. There's no need to wait for any
8+
approval.
9+
10+
!!! check "Development guidelines"
11+
* It-just-works - use good defaults that will work well for a first time user
12+
* Keep-it-simple - try to keep stuff beginner-friendly and don't go too
13+
deep into advanced topics
14+
315
## Writing documentation
416

17+
!!! tip inline end
18+
For simple changes you can straight-up just use the edit link available on
19+
every documentation page. It's the pen-icon to the right of the top
20+
heading. Write your changes, preview everything looks as expected and
21+
submit as proposed changes.
22+
523
Documentation is is written as markdown, processed using mkdocs ([docs](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-your-docs)) and the Material theme ([docs](https://squidfunk.github.io/mkdocs-material/reference/)). The Material theme is not just styling, but provides additional syntax extensions.
624

725
Setup your system for mkdocs and Material:

0 commit comments

Comments
 (0)