WIP: Improve documentation on how to contribute to documentation #183
Conversation
01-Introduction.Rmd
Outdated
| 2. Contributing to translations: Refer [Translations](#). | ||
| 3. Testing R before release: Refer [Testing Pre-release R Versions](#TestRVer). | ||
| 4. Contributing to documentation and tutorials: Refer [Documenting R](#Doc). |
There was a problem hiding this comment.
Is it worth adding a note here that this is a common starting point for new contributors, or add this later?
SJaffa
changed the title
| <!-- TODO(Saranjeet): Welcome to Bug BBQ slides --> | ||
| <!-- TODO(Saranjeet): README on Bug BBQ repo --> | ||
|
|
||
| Maintainers and contributors are requested to follow this project's [code of conduct](https://github.com/r-devel/rdevguide/blob/main/CONDUCT.md). |
There was a problem hiding this comment.
This change is not directly related to my aim of helping people contribute to docs, but in reading as a new contributor I found I clicked away on links before getting to this important statement at the end of the page, so it may be better to put it higher up to ensure people are aware fo the CoC before they go into the details of how to contribute.
Trying to put the introductory sections higher up and splitting later material into: code docs, tutorials, this guide.
|
|
||
| If you see a documentation issue that you would like to tackle, you can leave a comment on the issue saying you are going to try to solve the issue and mention roughly how long you think you will take to do so (this allows others to take on the issue if you happen to forget or lose interest). | ||
|
|
||
| If you find some typo or problem on [CRAN](https://cran.r-project.org) after checking the problem or typo you can write a polite email to `[email protected]` and one of the R-core members working with CRAN. You'll probably get a prompt reply about how the issue is going to be fixed. |
There was a problem hiding this comment.
In line 26 (next paragraph) the email suggested is different. I think [email protected] is the right one.
…ly closed bugs
|
I've continued this PR in my own fork and raised #188, in there I've copied all the same changes across and responded to all comments raised here. I think this PR can be closed now? |
At RSECon24 R dev day. Looking at r-devel/r-dev-day#55, and #118, but not sure if it fully closes either of them yet.
New contributors can often get started by updating or improving documentation. Add more details to the R dev day guide about how to do this.
Changes made:
I have added a note to the introduction page and reordered the documentation page to help people find the different kinds of documentation they can work on.
Not done:
Also mentioned in #118 is adding some examples of documentation issues, perhaps linking to a successfully closed issue.I have not done this as I run out of time, so someone else will need to take this on.