Add contributing guidelines

JakobGM / astrality

Astrality - A modular and dynamic configuration file manager

https://astrality.readthedocs.io

MIT License

98 stars 3 forks source link

Add contributing guidelines #7

Closed JakobGM closed 6 years ago

JakobGM commented 6 years ago

First draft of contributing guidelines for new contributors.

coveralls commented 6 years ago

Pull Request Test Coverage Report for Build 247

0 of 0 (NaN%) changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 97.21%

Totals
Change from base Build 245:	0.0%
Covered Lines:	2648
Relevant Lines:	2724

💛 - Coveralls

JakobGM commented 6 years ago

OK, I've rewritten the guideline according to you feedback. Let me know if there is anything you would like different in the new sections, and let's merge it afterwards ;)

JakobGM commented 6 years ago

I've also included a section explaining how to debug Astrality by setting a more granular logging level.

JakobGM commented 6 years ago

Great, thanks for the feedback, I'll merge it in!

It will be linked from readthedocs too, where it will be rendered in the same style as the rest of the documentation.