Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.35 KB

incoming_repo_requirements.md

File metadata and controls

74 lines (53 loc) · 3.35 KB
Raw

Requirements for Incoming Repositories

Thank you for looking at Django Commons to help maintain your repository! We're here to help find what is best for both the project and the community.

To see how to transfer a project into Django Commons, see How to transfer a project in?.

There are a few requirements that must be met before a project can be transferred in.

  1. All maintainers (people with release permissions) agree to the transfer
  2. New admins and maintainers are identified
  3. Tests that run in CI
  4. Maintained documentation
  5. Adopt Django Commons's Code of Conduct
  6. After transferring, switch to PyPI's "Trusted Publisher" process (see example in django-commons-playground)

Repository requirements

Tests

  • [Required] Clear instructions on how to run tests
  • [Required] Tests run with at least oldest supported LTE versions of Django and Python
  • [Suggested] Good test coverage (>70%)

Documentation

  • [Required] How to install and use the project
  • [Required] How to contribute
  • [Required] Organized and maintainable
  • [Suggested] Contains architecture documentation

Code of Conduct

Maintainer requirements

  • [Required] All maintainers (release permission) agree to transfer project
  • [Required] The repository will be transferred to the django-commons GitHub organization
  • [Required] The Django Commons admins team is added as owners to PyPI project
  • [Required] After 30 days, any previous maintainers are removed as owners on PyPI project

The current maintainers must be willing to hand over control of the PyPI project. The Django Commons admins team and the Django Commons's repository admin team specific to this repo will accept possession of the PyPI project.

The repository must identify which people will be the new maintainers moving forward. This can contain existing maintainers.

If desired, the current maintainers can temporarily join the Django Commons's repository admin team to ensure the project's standards are met during the process. Being on this team gives them all the controls they would need to transfer the repository out of Django Commons, back under their control. After the trial period, they may be removed from Django Commons's repository admin team. Regardless, it's recommended that a project go through the formal transfer a project out of Django Commons process.

Funding

This is still in the works for Django Commons. If a repository has a prior funding arrangement, that can continue provided any future maintainer receives an equal share. Additionally, if Django Commons defines a formal funding policy, that must be adopted by the repository.