As mentioned in #2, a practical setup guide would bring consistency and helps transferring knowledge on all technicalities of setting up a repo.

The following issue has most of the ingredients, but needs to be transformed into a readable form with more detail: theochem/iodata#313

TODO:

• Create initial framework for such documentation. See #7
• Recommended branch protection rules
• Setuptools
• Recommended Packages to facilitate development
• Non-python-package repository with venv and pip-tools
• Pre-commit. See #7
• Unit testing
• Code coverage
• Documentation build and deployment
• Deployment on PyPI
• Deepsource analysis
• Sourcery AI pull request review
• Code factors analysis
• Changelogs
• Sphinx docs
• Jupyter Book

It would be good to rename this repository to .github, so we can use it to define default community health files, as documented here:

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

Some files can also be renamed to make them more standard, which should improve the integration with GitHub.

I'm happy to take care of this, so we can start centralizing some recent changes made in IOData. (I'd also include a basic pre-commit configuration, to streamline future updates to this repo

@PaulWAyers Would this be ok for you? Any concerns?

We need to harmonize the contributing guidelines here with those from IOData.
https://github.com/tovrstra/iodata/blob/1032c13485a2dba0f8298617028145d806d5dc1d/CONTRIBUTING.rst

We should also, eventually, carefully document the development protocol (how to set up releases, GH actions, etc.) and harmonize it across repositories.