Document how to setup a repo
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Dockerfile
- Stars
- 1
- Forks
- 2
- Avg merge
- 22m
- Merged PRs (30d)
- 4
Description
We should write down somewhere how and why our repos are structured the way they are. May also make sense to put some of these details in SimDE so people using the SimDE can follow suite.
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 organization’s repository structures and the SimDE context mentioned in the issue. Document how repositories are set up, why they are structured that way, and any details SimDE users need to follow; the issue is complete when this guidance has an agreed location and covers both audiences.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100