Document default repository and continuous integration setup
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github, jupyter, python
- Domain
- build-system, ci-cd, documentation, release, testing
Research direction
Start by reading the referenced issue #313, then compare its material with the framework planned in #7 and the context from #2. Turn the listed setup topics into a readable, detailed guide covering repository protection, Python tooling, testing, documentation, analysis, releases, and changelogs; done means the checklist is addressed coherently.
Written by the indexing model from the issue text.
Description
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: https://github.com/theochem/iodata/issues/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
- Dominant language
- No language data
- Stars
- 9
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from theochem/.github
All issues in theochem/.github
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
priority: p3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
googleapis/librarian#7636 ·
-
package-update
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
oSoWoSo/vOid_Community_repOsitory#147 · 1 comment ·
-
Builders
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100