Decide what types of practices we would like to align on and document here
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We did some work on this a few years ago, and that work can be found here:
https://bit.ly/2dii-practices
Some examples of types of things we might want to document are:
- Git practices (technical)
- GitHub practices (technical)
Language agnostics practices (style guides, linters, minimal dependencies, unit-tests, integration tests, flagging and identifying tech debt to PO)this has moved to https://github.com/RMI-PACTA/Actions- Language (e.g. R or Docker) specific practices
- Developer/ community values (Relates to RMI-PACTA/practices#4)
Some other general practices/ principles we might consider documenting are:
- The use-case of a
pacta.*type package, or aworkflow.*type workflow (and when something would fit in one or the other) - When should you
Dockerfile
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 the prior work at https://bit.ly/2dii-practices and the note that language-agnostic practices moved to RMI-PACTA/Actions. Identify which practice categories this repository should cover, including Git, GitHub, language-specific practices, community values, and pacta.* versus workflow.* guidance. Done means the scope is agreed and the selected practices are documented here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dockerfile, git, github, r
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100