forked from WandererXII/lishogi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
19 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
custom: https://lichess.org/patron | ||
custom: https://lishogi.org/patron |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,29 @@ | ||
# Contributing | ||
|
||
## I want to contribute code to Lichess | ||
## I want to contribute code to Lishogi | ||
|
||
- [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 [good first issue](https://github.com/ornicar/lila/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 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/YFtpMGg3rR). | ||
- [Set up your development environment](https://github.com/ornicar/lila/wiki/Lichess-Development-Onboarding). Just replace https://github.com/ornicar/lila.git with https://github.com/WandererXII/lishogi.git and https://github.com/ornicar/lila-ws.git with https://github.com/WandererXII/lila-ws.git. Install gulp-cli too. | ||
- To play against AI and use server analysis install this as well https://github.com/WandererXII/shoginet. At least 4 GB RAM is needed to run it, 8 GB to work with lishogi + lila/ws + shoginet, and maybe 10 to run bloop + metals as well. | ||
- [Pick a GitHub issue to work on](https://github.com/WandererXII/lishogi/issues). The [High priority](https://github.com/WandererXII/lishogi/issues?q=is%3Aissue+is%3Aopen+label%3A%22High+priority%22) tag might be useful. | ||
- Communicate with other devs on [Lishogi's Official Discord](https://discord.gg/YFtpMGg3rR). | ||
|
||
## I want to report a bug or a problem about Lichess | ||
## I want to report a bug or a problem about Lishogi | ||
|
||
[**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: | ||
[**Make an issue**](https://github.com/WandererXII/lishogi/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. | ||
|
||
Report mobile-only bugs to [Lichess mobile](https://github.com/veloce/lichobile/). | ||
## I want to suggest a feature for Lishogi | ||
|
||
## 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](https://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: | ||
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 [Lishogi Feedback Forum](https://lishogi.org/forum/lishogi-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/WandererXII/lishogi/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 | ||
## I want to help translating Lishogi | ||
|
||
Check out [Lichess on crowdin.com](https://crowdin.com/project/lichess). | ||
Check out [Lishogi on crowdin.com](https://crowdin.com/project/lishogi). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Contact: mailto:contact@lichess.org | ||
Encryption: https://lichess.org/.well-known/gpg.asc | ||
Contact: mailto:contact@lishogi.org | ||
Encryption: https://lishogi.org/.well-known/gpg.asc | ||
Preferred-Languages: en | ||
Canonical: https://lichess.org/.well-known/security.txt | ||
Policy: https://lichess.org/contact#help-security | ||
Canonical: https://lishogi.org/.well-known/security.txt | ||
Policy: https://lishogi.org/contact#help-security |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters