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

Pin style checkers and formatters #295

Merged
merged 1 commit into from
Jan 14, 2022
Merged

Pin style checkers and formatters #295

merged 1 commit into from
Jan 14, 2022

Conversation

leouieda
Copy link
Member

Leaving them unpinned, particularly when we have so many now is going to
be a nightmare. Better to have them pinned in the environment.yml and
env/requirements-style.txt files and we upgrade them from time to time.
Fixes a false-positive from the updated RST linter.

Could be a good excuse for us to finally setup dependabot to send PRs when new versions of the linter come out.

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Leaving them unpinned, particularly when we have so many now is going to
be a nightmare. Better to have them pinned in the environment.yml and
env/requirements-style.txt files and we upgrade them from time to time.
Fixes a false-positive from the updated RST linter.
@santisoler
Copy link
Member

Thanks for pinning them! I'm merging this.

@santisoler santisoler merged commit b548d9e into main Jan 14, 2022
@santisoler santisoler deleted the flake8 branch January 14, 2022 16:08
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.

None yet

2 participants