Description
One of Django Commons' goals is to help third-party packages follow best/standard practices. We've been working on a repo which does this.
The general task is to define how to run tests, define CI, define how the project accepts funding and automate pushing changes to the Security and CoC yamls to several projects.
Prospective contributils will need to be able to read and write documentation, review existing third-party packages, be willing to experiment / make mistakes, work with PyPI and GitHub actions, and be open to feedback.
If you'd like to help on this
Please add a comment to the issue and indicate which of the things below you're going to work on and what you need help with to get started.
Task breakdown
- Test suite configuration (Define test suite configuration for best-practices and repos #80)
- Python and Django version matrixes
- GitHub actions integration
- Database configurations
- Running test suite locally
- Speed optimizations with uv and caching
- Define funding.yml file (Define suggested funding opportunities for packages in best-practices #77)
- This can likely be a template for people to copy and tweak
- Code of Conduct and Security files (Implement standard GitHub community health files using repository references #65)
- CoC should be a file that we push down to repos when there's a change to the membership repo's code of conduct
- Security should be a file that we push down to repos, but we'll need some configuration to identify who exactly
- Package versioning and releases to support test releases (Define package versioning and releases to support test releases for best practices repo #81)
- Currently the best practices repo uses semvar with an environment variable for dev versioning to support uploads to testpypi
- Standard pre-commit.yml file (Add a standardized python project pre-commit yml to django-commons-playground #9)
There are some resources in the community who may be able to help provide guidance such as Adam Johnson and Matthias Kestenholz.