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 contributing guide #1876

Closed
wants to merge 7 commits into from
Closed

Conversation

replaceafill
Copy link
Member

@replaceafill replaceafill commented Nov 29, 2023

This updates the contributing guide to reflect our current development process better and address some common problems:

  • GitHub automatically uses the stable/* branch for new pull requests. This instructs contributors to use the qa/* branch instead which is the focus of our development.
  • We usually request new contributors to sign the contributor agreement before engaging in the code review
  • We have introduced pre-commit for formatting and linting our code which replaces the need to use different formatting and linting tools like pylint separately. pre-commit is available for developers in the Docker development environment and enabled as a continuous integration job.
  • Archivematica dropped Python 2.7 compatibility a couple of versions ago.
  • We prefer not to add more tests based on Django's TestCase anymore since their fixture system is less flexible than pytest.
  • Maintaining pyvcr fixtures is problematic as well and recent versions have introduced a compatibility problem for us.

The code review guidelines document has also been updated.

@eviau-artefactual
Copy link
Contributor

Thanks for keeping me in the loop - this looks good to me.

Copy link
Contributor

@eviau-artefactual eviau-artefactual left a comment

Choose a reason for hiding this comment

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

The one thing I would add is links to any relevant PR, Issue or something else - e.g. I see that we are not linking to VCR.py anymore, but maybe in the future we would like to know why this has been removed.

@replaceafill
Copy link
Member Author

Thank you @eviau-artefactual! That's a great point. Apologies for not being explicit. I've explained a few of the changes in the pull request description.

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