Skip to content

Commit 621eb92

Browse files
committed
add CONTRIBUTING file
1 parent 3a1f72d commit 621eb92

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
CONTRIBUTING ON NILE
2+
============
3+
4+
There are three ways in which you can contribute to the nile project:
5+
6+
1. By improving the documentation or [specification](https://github.com/nileorg/nile-specifications).
7+
2. By solving an issue of our code basis issue lists.
8+
1. [instance issue list](https://github.com/nileorg/nile-local-instance/issues)
9+
2. [node issue list](https://www.nile.shopping) (soon)
10+
2. [client issue list](https://www.nile.shopping) (soon)
11+
3. By testing the application and report bugs or suggestions.
12+
13+
Choosing what to work on in a large open source project is not easy. The general list of issues can you find here: [Nile general issue list](https://github.com/nileorg/nile-development/issues).
14+
15+
16+
## General
17+
- If something is unclear for you, you can ask anything in the #development channel in [our Discord server](https://discord.gg/eZFan9).
18+
19+
20+
## Development
21+
22+
- Create a merge request and describe your intention for the changes.
23+
- The test suites and linters must pass. More information about this you will find in the README.md files of each repository.
24+
- Verify that your changes work ;-)
25+
26+
## Documentation
27+
28+
- No spelling mistakes
29+
- No orthographic mistakes
30+
- No Markdown syntax errors

0 commit comments

Comments
 (0)