docs: add slightly tweaked boilerplate CONTRIBUTING.md #1423
Conversation
Current Aviator status
This PR was merged using Aviator.
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
.github/CONTRIBUTING.md
Outdated
| ## Fixing typos | ||
|
|
||
| You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. | ||
| This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. | ||
| You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. |
There was a problem hiding this comment.
Will people need to regenerate the .Rd file themselves (how?), or will this be done for them?
There was a problem hiding this comment.
we'd do it for them for now
.github/CONTRIBUTING.md
Outdated
| ### Pull request process | ||
|
|
||
| * Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("igraph/rigraph", fork = TRUE)`. | ||
|
|
||
| * Install all development dependencies with `pak::pak()`, and then make sure the package passes R CMD check by running `devtools::check()`. | ||
| If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. | ||
| * Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. | ||
|
|
||
| * Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. | ||
| The title of your PR should briefly describe the change. | ||
| The body of your PR should contain `Fixes #issue-number`. |
There was a problem hiding this comment.
Are you sure that managing Git entirely through R packages is the easiest, most user friendly way? Personally I find this very confusing, and I wouldn't trust any automated solution to create a PR for me. I'd rather create my own PR: it's easy enough from GitHub's web interface.
But then I'm not coming from R.
There was a problem hiding this comment.
I tweaked the text! I actually use... another R package 😂 (gert)
.github/CONTRIBUTING.md
Outdated
| * We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. | ||
| Contributions with test cases included are easier to accept. |
There was a problem hiding this comment.
Should tests be required for all new feature? (I think they should.)
There was a problem hiding this comment.
Ok, I changed the phrasing.
There was a problem hiding this comment.
I added some comments, as you requested, and I hope they are helpful. I think these decisions should be made by @krlmlr @maelle @Antonov548 (the R team), so please take them as comments/suggestion, not requests. I am not familiar with R development customs.
Speaking of styling, let's make that consistent for Markdown as well. Either use no line breaks at all in paragraphs (this is what I do) or break everything at a consistent column number. Right now this .md file is a bit of a mess, formatting-wise 😃
|
@krlmlr @Antonov548 feel free to suggest changes, I'm going to go ahead and merge this as nothing looks controversial to me. 😇 (optimistic merging!) |
Fix #1422
cf #1421 (comment)
The
CONTRIBUTING.mdguide is where R developers would expect to find these things, especially as pkgdown will link to the file automatically.