Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.51 KB

Contributing to lichess_db development

Thank you for considering contributing to lichess_db. Below we provide some guidelines for contributing:

  • Reporting a bug
  • Suggesting a new feature to the package
  • Contributing code

Reporting a bug

If you found a bug in lichess_db, we would love to know more about it. Please let us know about this problem by opening an issue.

The most important thing to include in your new issue is a minimal reproducible example that we can use to verify your problem and understand its root cause.

For more information about issues, please refer to the official GitHub guides!

Suggesting a new feature to lichess_db

We are very interested in hearing your suggestions in regards to the development of new lichess_db features. Let us know about what you think we should add next by opening a new issue.

Conributing code

To contribute code to lichess_db, you can follow these three steps:

  1. Create a branch and make your changes
  2. Push the branch to GitHub and issue a Pull Request (PR)
  3. Discuss with us the pull request and iterate of eventual changes

You can read more about pull requests using GitHub's official documentation.