Umbrella issue: open-source ready

[nenb]

Here are a bunch of outstanding tasks that we need to do to align with common OSS ways of working:

• Add CONTRIBUTING.md and consolidate all READMEs (eg requirements/README.md) here
• Fix licence in pyproject.toml
• Update branch protections and repository settings
• Add .gitattributes to manage our use of Jupyter notebooks
• Extend CI to all common platforms (partially complete, see Expand CI to Include windows-latest #458)
• Consider use of GitHub packages for CI artifacts (Docker image?) Not doing, see Umbrella issue: improving the health of our test suite #388
• Update landing page README.md
• Clarify our versioning policy
• Add build and release to CI (this can be separate to PyPI upload, it tags the release on GitHub)
• Clarify where we will host our docs. If using ReadTheDocs, complete necessary configuration
• Make coverage publicly visible
• Determine project keywords (relevant for repo and for pyproject.toml)
• Add CHANGELOG.md (or something equivalent) we will not add this - see Add Changelog action #472

[blythed]

One other thing - badges - seems to be a generally accepted thing to do. Thoughts?

[blythed]

For the CONTRIBUTING.md I started using the inbuilt wiki functionality. I'm guessing the CONTRIBUTING.md is standard though?

What do we want for branch protection -- currently needs 1 approval and green tests for merge. I guessing we should also make sure that only certain project owners can push the go ahead for a merge?

[rec]

I suggest this add/edit

• Create a list of supported platforms and minimum specs
• Extend CI to all supported platforms

---

If we require a CHANGELOG.md, it would be less work on us if it be automatically generated as part of the release process by filling in the names of all the commits since the last release, there must be some tool to do that (I have an old one I wrote that does that if needs be).

We can always edit it by hand afterward if we like.

---

github pages are pretty good, but I do like ReadTheDocs, if only to avoid the monoculture.

---

Badges are great, everybody likes them, they give you a quick information at a glance. Can't believe I didn't think of that. :-P

[blythed]

CI business covered by #388

[nenb]

Closing as we have now released.