GamesMirror/adarkroom
1
0
Fork 0
mirror of https://github.com/doublespeakgames/adarkroom.git synced 2026-05-28 00:01:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Create contributing.md

Browse Source 
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/
This commit is contained in:
mac craig
2015-05-27 22:01:01 -07:00
committed by Blake Grotewold
parent 2d207e55c1
commit 612d247709
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contributing.md
+19
View File
@@ -0,0 +1,19 @@
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.
<br><hr>
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](http://jshint.com/) compliant.
> "JSHint is a community-driven tool to detect errors and potential problems in JavaScript code and to enforce your team's coding conventions."
<br><br><br>
Before opening a new issue, try to check the projects [issues](https://github.com/doublespeakgames/adarkroom/issues) or [wiki](https://github.com/doublespeakgames/adarkroom/wiki).
Doing so will help prevent needless double issues.
<br>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!