protocolhelper for non frequent R / Git users?
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 2
- Forks
- 5
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
Description
Depending on which (INBO) audience you would like to reach to use protocolhelper (I am not a frequent R person, and I did follow the INBO Git course at one point in time, but not recently + not a frequent user), I think you could perhaps "dumb the instructions down"?
For example, if you are someone who needs protocolhelper on an infrequent basis, there could be a section: "Returning to protocolhelper" where you describe how to open de Rproject, perhaps how to check dependencies?
Then for example the instruction below:
The instruction to do the Pull request is intuitive, however it might not be intuitive for the readers to "checkout the main branch"? I could retrace the meaning of checkout from the Git workshop notes; but still finding the correct place in the Git pane when not using it frequently, is not that intuitive. For example I had already pushed the pull button, while searching how to "checkout the main branch", while I didn't check if I was on 'main' (but I was on 'main', so I guess no harm done).
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 locating the documentation that explains returning to protocolhelper, checking dependencies, and creating a pull request. Review the guidance from the perspective of an infrequent R and Git user; done means the relevant instructions clearly explain opening the R project, checking dependencies, and confirming or checking out the main branch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100