search

py-stockfish / stockfish

Integrates the Stockfish chess engine with Python (Official fork)
https://py-stockfish.github.io/stockfish/
MIT License
29 stars 8 forks source link

Update the gitignore and readme to aid contributing #70

Closed johndoknjas closed 1 month ago

johndoknjas commented 3 months ago

This PR adds some tips to the readme on how contributors can test their changes made to stockfish/models.py. The gitignore is also updated so that executables and a main.py file are ignored in the stockfish folder. Minor updates to some get_wdl_stats stuff is also done.

github-actions[bot] commented 3 months ago

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)		Lines missing
  stockfish
  models.py
Project Total  

This report was generated by python-coverage-comment-action

johndoknjas commented 3 months ago

@kieferro I added one more update to the readme - just putting the new section on contributing right before testing, and then updating the testing section with a tip on how to run things locally with the right path name.

This is how I run the tests on my machine, was just wondering if you do something similar. If so, this may be something we could look into changing, so that contributors can run the test suite without needing to modify the default path in models.py.

kieferro commented 3 months ago

was just wondering if you do something similar

Yes, I do pretty much the same.

this may be something we could look into changing

Yes, I think that's a very good suggestion. Maybe we could use a setup with a command line argument, which is read by test_models.py and then passed as the path for the Stockfish fixture