diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c3bff7d97..613f3af141 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,24 +3,28 @@ Contributing ## I want to contribute code to Lichess -- [Set up your development build](https://github.com/ornicar/lila/wiki/Lichess-Development-Onboarding) -- [Pick a github issue to work on](https://github.com/ornicar/lila/issues) +- [Set up your development environment](https://github.com/ornicar/lila/wiki/Lichess-Development-Onboarding). +- [Pick a GitHub issue to work on](https://github.com/ornicar/lila/issues). The [basic](https://github.com/ornicar/lila/issues?q=is%3Aissue+is%3Aopen+label%3Abasic) and [no scala](https://github.com/ornicar/lila/issues?q=is%3Aissue+is%3Aopen+label%3A%22no+scala%22) tags might be useful. - Communicate with other devs on the #lichess IRC channel on freenode or [discord](https://discord.gg/AWSze7n). ## I want to report a bug or a problem about Lichess -[__Make an 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 provide little value compared to the required effort may be closed. Before creating an issue, make sure that: +[__Make an issue__](https://github.com/ornicar/lila/issues/new). However, note that issues that provide little value compared to the required effort may be closed. 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. [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 time to fix. Pluralization bugs and the such fall under this category. +3. It is not a trivial problem or demand unrealistic dev time to fix. ## 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 the idea there, and if it is exemplary, a corresponding issue ticket will be made. __When you're ready, [make an issue ticket](https://github.com/ornicar/lila/issues/new?title=Please+implement+this+chess+variant+idea+I+came+up+with)__ 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: +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 the idea there, and if it is exemplary, a corresponding issue ticket will be made. __When you're ready, [make an issue ticket](https://github.com/ornicar/lila/issues/new)__ 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. + +## I want to help translating Lichess + +Check out [Lichess on crowdin.com](https://crowdin.com/project/lichess). diff --git a/COPYING.md b/COPYING.md index 435a79914f..0d608444c0 100644 --- a/COPYING.md +++ b/COPYING.md @@ -91,3 +91,4 @@ Lichess as deployed on https://lichess.org/ also uses these external services: * [Google Fonts](https://fonts.google.com/) * [Google Cloud Messaging](https://developers.google.com/cloud-messaging/) and [OneSignal](https://onesignal.com/) for mobile notifications * [reCAPTCHA](https://www.google.com/recaptcha/) +* [crowdin](https://crowdin.com/project/lichess) for localization diff --git a/README.md b/README.md index aa2ae71f4e..25afed10e8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -[lichess.org](https://lichess.org) [![Build Status](https://travis-ci.org/ornicar/lila.svg?branch=master)](https://travis-ci.org/ornicar/lila) ---------------------------------- +[lichess.org](https://lichess.org) +================================== -[@lichessorg](https://twitter.com/lichessorg) +[![Build Status](https://travis-ci.org/ornicar/lila.svg?branch=master)](https://travis-ci.org/ornicar/lila) +[![Crowdin](https://d322cqt584bo4o.cloudfront.net/lichess/localized.svg)](https://crowdin.com/project/lichess) +[![Twitter](https://img.shields.io/badge/Twitter-%40lichessorg-blue.svg)](https://twitter.com/lichessorg) lichess.org @@ -16,7 +18,7 @@ It features a [search engine](https://lichess.org/games/search), [tactic trainer](https://lichess.org/training), a [mobile app](https://lichess.org/mobile), and a [shared analysis board](https://lichess.org/study). -The UI is available in more than [80 languages](https://lichess.org/translation/contribute) thanks to the community. +The UI is available in more than [80 languages](https://crowdin.com/project/lichess) thanks to the community. Lichess is written in [Scala 2.11](https://www.scala-lang.org/), and relies on [Play 2.4](https://www.playframework.com/) for the routing, templating, and JSON. @@ -31,7 +33,7 @@ Browser testing done with [![](https://raw.githubusercontent.com/ornicar/lila/ma Translations powered by [Crowdin](https://crowdin.com). [Join us on discord](https://discord.gg/AWSze7n) or in the #lichess freenode IRC channel for more info. -Use [github issues](https://github.com/ornicar/lila/issues) for bug reports and feature requests. +Use [GitHub issues](https://github.com/ornicar/lila/issues) for bug reports and feature requests. Installation ------------