philipstarkey
commented
6 years ago Original comment by Chris Billington (Bitbucket: cbillington, GitHub: chrisjbillington).
Checklist draft:
- code coverage with coverage.py
- test suites
- sphinx docs
- readme
- bitbucket pipelines
- some kind of link to unified docs or homepage for the suite as a whole, or a common introduction. The separation into repositories makes it hard to have a landing page common to the whole project, so we need to include a quick introduction as well as link to the 'getting started' docs for the project as a whole, so that linking to a specific project can still be a link to an overview of the whole project.
- contributing guidelines
- changelog
- list of contributors?
Basic skeletons of these should be implemented even if they lack content initially so that the process is in place to improve them over time.
Original report (archived issue) by Chris Billington (Bitbucket: cbillington, GitHub: chrisjbillington).
Create a checklist of minimum things each subproject needs - version numbers, readme that renders well on bitbucket, sphinx document skeleton, pip installability, and check that each project has them and implement missing aspects one by one. Maintain this checklist somewhere so that it can be updated when processes change.