protocolhelper for non frequent R / Git users?
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- git, r
- Domain
- documentation
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.
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).
- Dominant language
- R
- Stars
- 2
- Forks
- 5
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
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.
More from inbo/protocolsource
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
inbo/protocolsource#147 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
inbo/protocolsource#143 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
inbo/protocolsource#101 · 3 comments ·
All issues in inbo/protocolsource
Similar issues
-
documentation pkg infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
epiverse-trace/epiparameter#511 ·
-
function:write_dwc
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Urgent request: Due to vulnerabilities move to API version 12.6.1 (12.6.2 eventually) or 13.1.1 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
jbkunst/highcharter#849 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
r-lib/pkgdepends#485 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100