Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miguel-ambrona authored Aug 20, 2024
1 parent cf5c6d7 commit 61f584c
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@ Be sure to include a detailed description of the problem.

### Testing the limits of Sherlock

Sherlock is not _complete_ (yet?). There are many illegal positions that cannot
be captured by Sherlock. Try to find one of them! If you do so, please, open an
issue and label it as
https://github.com/miguel-ambrona/sherlock/labels/enhancement.
Sherlock is not _complete_ (yet?). There are many illegal positions that are
not captured. Try to find one of them! If you do, please, open an issue and
label it as https://github.com/miguel-ambrona/sherlock/labels/enhancement.

On the other hand, Sherlock is supposed to be _sound_, i.e. it should never
classify a legal position as illegal. If you find otherwise, please open an
Expand All @@ -33,10 +32,10 @@ Sherlock is made of multiple (usually very simple) deduction
[rules](https://github.com/miguel-ambrona/sherlock/tree/main/src/rules) that
allow us to derive new information about a position.

A great way to contribute is to add new rules to Sherlock that would enhance
his expressivity. Every rule must implement the
A great way to contribute is to add new rules to Sherlock. Every rule must
implement the
[Rule trait](https://github.com/miguel-ambrona/sherlock/blob/main/src/rules.rs#L5-L24),
have a look at some of the
have a look at the
[existing rules](https://github.com/miguel-ambrona/sherlock/tree/main/src/rules)
for some examples.

Expand All @@ -52,9 +51,9 @@ project's style.

## License

By contributing to Stockfish, you agree that your contributions will be licensed
By contributing to Sherlock, you agree that your contributions will be licensed
under the MIT License.
See [LICENSE](https://github.com/miguel-ambrona/sherlock/blob/main/LICENSE) for
more details.

Thank you for contributing to Sherlock and helping us make it even better!
Thank you for contributing to Sherlock and helping us make it even better!

0 comments on commit 61f584c

Please sign in to comment.