Document CI
Open
Nobody has claimed this yet.
- Dominant language
- Dockerfile
- Stars
- 1
- Forks
- 2
- Avg merge
- 22m
- Merged PRs (30d)
- 4
Description
This is a follow up to NWChemEx-Project/DeveloperTools#114. We need to add developer notes explaining where the various pieces of CI live and how future modifications to CI can be accomplished. I think it makes sense to do this after we've closed most of the issues on the CI board and know that the current design will work (I don't see why it wouldn't).
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.
Research direction
Start by reviewing DeveloperTools#114 and the current CI board to identify the CI pieces that are stable enough to document. Map where those pieces live and describe how future CI modifications should be made; done means the developer notes cover the current layout and modification process.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100