opensafely / opensafely/documentation
More Git guidance
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
The "How to use Git effectively" page offers links, but not guidance (#45). @inglesp (and possibly @sebbacon) think there's a need to offer guidance.^1 However, it's not clear what "using Git effectively" means within the context of study code. (I'm reminded of a researcher recently saying something like "I don't know how to use Git. Am I a bad person?")
We should consider:
- formulating some guidelines
- getting some feedback from researchers and software developers
- updating the "How to use Git effectively" page
Note that the Team Manual has a "Git and GitHub etiquette" page, which is directed at members of the tech team.
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 "How to use Git effectively" page and the Team Manual's "Git and GitHub etiquette" page. Clarify what effective Git use means for study code, gather feedback from researchers and software developers, and update the documentation page with agreed guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100