Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.33 KB

Coding rules/guidelines

  • Each fixture must have reasonable docstring (to reproduce setup manually)
  • Each test must have reasonable docstring (to reproduce action(s) manually)
  • Test module docstring for highlevel description of purpose is highly desirable
  • [doc/examples.py] is collection of code snippets showing common actions
  • make commit-acceptance has to be used for lint analysis

Pull Requests

Pull Request Review

  • Review from two reviewers is required
  • No pending change requests in reviews
  • No unresolved conversations
  • All checks have to pass

Ignore format commits with git blame

When making commits that are strictly formatting/style changes (e.g., after running a new version of black or running pyupgrade after dropping an old Python version), add the commit hash to .git-blame-ignore-revs, so git blame can ignore the change.

For more details, see: https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile pydata/pydata-sphinx-theme#713