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

Make pre-commit match Gymnasium (add many more pre-commit hook checks) #1012

Merged

Conversation

elliottower
Copy link
Contributor

Description

  • update version for pyupgrade, add project arg to pyright (may not do anything but good to be clear), and add the following additional pre commit hooks:
      - id: check-symlinks
      - id: destroyed-symlinks
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-toml
      - id: check-ast
      - id: check-added-large-files
      - id: check-merge-conflict
      - id: check-executables-have-shebangs
      - id: check-shebang-scripts-are-executable
      - id: detect-private-key
      - id: debug-statements
      - id: mixed-line-ending

To get the executables have shebangs one to pass I had to fix this error:

pettingzoo/sisl/waterworld/waterworld_base.py: marked executable but has no (or invalid) shebang!
If it isn't supposed to be executable, try: chmod -x pettingzoo/sisl/waterworld/waterworld_base.py
If on Windows, you may also need to: git add --chmod=-x pettingzoo/sisl/waterworld/waterworld_base.py
If it is supposed to be executable, double-check its shebang.

This was fixed by the suggestion it says: git add --chmod=-x pettingzoo/sisl/waterworld/waterworld_base.py, which I had to do for a few other files as well

Fixes # (issue), Depends on # (pull request)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.
To upload images to a PR -- simply drag and drop or copy paste.

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@elliottower elliottower merged commit 110333f into Farama-Foundation:master Jul 6, 2023
@elliottower elliottower deleted the pre-commit-match-gymnasium branch July 6, 2023 19:53
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.

1 participant