4f7fe255c7
The UCI protocol is rather technical and has little value in our README. Instead it should be explained in our wiki. "Contributing" is moved above "Compiling Stockfish" to make it more prominent. Also move the CONTRIBUTING.md into the root directory and include it in the distributed artifacts/releases. closes https://github.com/official-stockfish/Stockfish/pull/4766 No functional change
3.2 KiB
Contributing to Stockfish
Welcome to the Stockfish project! We are excited that you are interested in contributing. This document outlines the guidelines and steps to follow when making contributions to Stockfish.
Table of Contents
Building Stockfish
In case you do not have a C++ compiler installed, you can follow the instructions from our wiki.
Making Contributions
Reporting Issues
If you find a bug, please open an issue on the issue tracker. Be sure to include relevant information like your operating system, build environment, and a detailed description of the problem.
Please note that Stockfish's development is not focused on adding new features. Thus any issue regarding missing features will potentially be closed without further discussion.
Submitting Pull Requests
-
Functional changes need to be tested on fishtest. See Creating my First Test for more details. The accompanying pull request should include a link to the test results and the new bench.
-
Non-functional changes (e.g. refactoring, code style, documentation) do not need to be tested on fishtest, unless they might impact performance.
-
Provide a clear and concise description of the changes in the pull request description.
First time contributors should add their name to AUTHORS.
Stockfish's development is not focused on adding new features. Thus any pull request introducing new features will potentially be closed without further discussion.
Code Style
We do not have a strict code style. But it is best to stick to the existing style of the file you are editing.
Community and Communication
- Join the Stockfish discord to discuss ideas, issues, and development.
- Participate in the Stockfish GitHub discussions for broader conversations.
License
By contributing to Stockfish, you agree that your contributions will be licensed under the GNU General Public License v3.0. See Copying.txt for more details.
Thank you for contributing to Stockfish and helping us make it even better!