Skip to content

Jazzband Contributing Guide#37

Open
dpgraham4401 wants to merge 7 commits intojazzband:mainfrom
dpgraham4401:jazzband_guidelines
Open

Jazzband Contributing Guide#37
dpgraham4401 wants to merge 7 commits intojazzband:mainfrom
dpgraham4401:jazzband_guidelines

Conversation

@dpgraham4401
Copy link
Member

@dpgraham4401 dpgraham4401 commented Mar 7, 2026

Description

  • Add a CONTRIBUTING.md guidelines to and use Jazzband's header,
  • Remove non-tested django versions from the list of tested versions in the readme
  • Add snippet on generating SECRET_KEYs with django
  • Use filter to avoid running lint and test workflow when only markdown files have changed.

Relevant issues

#17

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR implements several Jazzband guidelines for the django-fernet-encrypted-fields project (issue #17), including adding a contributing guide, updating the README with accurate test coverage info, and optimizing the CI workflow.

Changes:

  • Added CONTRIBUTING.md with Jazzband header, code of conduct reference, and step-by-step contribution instructions.
  • Updated README.md to correct the compatibility table (removing check marks for non-tested Django versions), add a SECRET_KEY generation snippet, fix a typo, and link to CONTRIBUTING.md.
  • Added path filters to the CI workflow to skip lint/test runs for markdown-only changes, and expanded .gitignore.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File Description
CONTRIBUTING.md New file with Jazzband header and contribution guidelines
README.md Added SECRET_KEY generation snippet, fixed typo, updated compatibility table, added contributing link
.gitignore Expanded with common Python and Node ignore patterns
.github/workflows/lint-and-test.yml Added paths filter to pull_request trigger (but push is unfiltered)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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