mac craig
612d247709
Creation of the contributing.md file to set rules and guidelines for future or current contributors. Let me know if you want me to set out some basic contributing guidelines, or if the owner has anything in mind. See the links below for information on contributing.md https://github.com/blog/1184-contributing-guidelines https://guides.github.com/activities/contributing-to-open-source/
1.2 KiB
Contributing to A Dark Room
Hello and welcome, contributors both new, and old.
Like most projects on GitHub, A Dark Room is open source, and thrives off contributions from members of the community. We appreciate any pull requests or issues that you may open in the project, no matter the size.
Before contributing to the project, there are a few things you should look over to ensure your contribution is done correctly.
Most of the projects code is written in JavaScript. We would prefer all submitted JavaScript be JSHint compliant.
"JSHint is a community-driven tool to detect errors and potential problems in JavaScript code and to enforce your team's coding conventions."
Before opening a new issue, try to check the projects issues or wiki.
Doing so will help prevent needless double issues.
Most of the time you will be able to find what you are looking for in one of those places. If not, please open an issue and describe your problem with as much detail as possible.
Lastly, be nice, patient, open to new ideas, and have some fun!