opensafely / opensafely/documentation
Update instructions for publishing your GitHub repo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
The current instructions for publishing your GitHub repo suggest making sure the "About" section of the repo is up to date. This requires the "maintain" permissions, which researchers no longer have. I suggest we remove instructions to do so, and direct users to tech-support if they do need to change this section. We can also provide instructions on filling this section in (and highlighting that it is not too easy to change) in the instructions for creating a repo. This will hopefully avoid too many of these requests for tech support.
@amirmehrkar @CLStables this may be linked to work you're doing around making work public
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
Read the publishing instructions at docs.opensafely.org/publishing-repo/ and the repository-creation instructions at docs.opensafely.org/getting-started/#2-create-a-new-repository-in-github. Remove the unavailable About-section guidance from publishing instructions, and add guidance there or in the repository-creation instructions about completing that section and contacting tech support when needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100