Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the gitignore and readme to aid contributing #70

Merged
merged 7 commits into from
Jun 2, 2024

Conversation

johndoknjas
Copy link

@johndoknjas johndoknjas commented Apr 12, 2024

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.

Copy link

github-actions bot commented Apr 12, 2024

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

Copy link
Member

@kieferro kieferro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks

@johndoknjas
Copy link
Author

@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
Copy link
Member

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

@johndoknjas johndoknjas merged commit 2397874 into py-stockfish:master Jun 2, 2024
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants