deepcrayon
/
lila
1
0
Fork 0
Code Releases Activity

Author contributors guide

pull/1473/head
Unihedron 2016-01-17 10:52:07 +08:00
parent 3eca1f25a7
commit a7a660296c
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -1 +1,22 @@
See https://github.com/ornicar/lila/wiki/Lichess-Development-Onboarding
#### I need help contributing code to Lichess.
__For setting up your development environment, [read this guide](https://github.com/ornicar/lila/wiki/Lichess-Development-Onboarding).__
If you experience any issues, __fix them yourself__ or __demonstrate your efforts and make it easy to help__. As stated in the read-me file, I do **not** offer support for your Lichess instance.
#### I want to report a bug or a problem about Lichess.
[__Make a issue ticket.__](https://github.com/ornicar/lila/issues/new?title=Submitting a forum thread with the word "thibault" in its title crashes my browser!) However, note that issues that are too minor and have no impact or doesn't deem the effort to may be closed and ignored. Before creating an issue, make sure that:
1. You list the steps to reproduce the problem to show that other users may experience it as well, if the issue is not self-descriptive.
2. Search to make sure it isn't a duplicate, otherwise it will be closed. [The advanced search syntax](https://help.github.com/articles/searching-issues/) may come in handy.
3. It is not a trivial problem or demand unrealistic dev hours to fix - Pluralization bugs and the such fall under this category.
#### I want to suggest a feature for Lichess.
Issue tickets on features that lack potential or effectiveness are not useful and may be closed. Discussions regarding whether a proposed new feature would be useful can be done on [The Lichess Feedback Forum](http://lichess.org/forum/lichess-feedback) to gauge feedback. The developers may also discuss about the idea there, and if it is exemplary, a corresponding issue ticket will be made. __When you're ready, [make a issue ticket](https://github.com/ornicar/lila/issues/new?title=Please implement this chess variant idea I came up with that is totally not stupid)__ and link relevant, constructive comments regarding it in your issue ticket (such as a detailed Reddit post; Linking to an empty forum thread with only your own commentary adds no value). Make sure that the feature you propose:
1. Is __effective in delivering a goal__. A feature that adds nothing new is purely fancy; Please develop a userscript or userstyle for your personal use instead.
2. Doesn't rely on mundane assumptions. Non-technical people have the tendency to measure how difficult / easy a feature is to implement based on their unreliable instincts, and such assumptions wastes everyone's time. __Point out what needs to happen__, not what you think will happen.
3. Is __unique, if you're aiming to solve a problem__. Features that can easily be replaced by easier ideas have little value and may not have to be brought up to begin with.
4. Is __clear and concise__. If ambiguities exist, define them or propose options.