Skip to content

Improve contribution guide #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 12, 2023
Merged

Improve contribution guide #464

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c152644
Add information on making bigger changes
jamesmbaazam Oct 3, 2023
7b304b8
Improve wording
jamesmbaazam Oct 3, 2023
5ec3b86
Bump up version
jamesmbaazam Oct 3, 2023
0763c6d
Add news item
jamesmbaazam Oct 3, 2023
4720823
Don't increment the dev version
jamesmbaazam Oct 4, 2023
517968b
Add a note on version increment
jamesmbaazam Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add a note on version increment
  • Loading branch information
@jamesmbaazam
jamesmbaazam committed Oct 4, 2023
commit 517968b5fef7805826cd39f6422e63d1733a9b34
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ precommit::use_precommit()
#### What happens after submitting a PR?

* PRs are reviewed by the team before they are merged. The review process only begins after the continuous integration checks, which have to be manually triggered by a maintainer for first-time contributors, have passed.

* The Github Actions checks currently take a while (about an hour), so it might be helpful to "watch" the repository and check your email for a notification when it's all done.

* Usually, all the review conversations occur under the PR. The reviewer merges the PR when every issue has been resolved. Please use the "Resolve conversation" functionality in the GitHub web interface to indicate when a specific issue has been adressed, responding with a commit pointing to the change made where applicable.
Expand All @@ -78,6 +79,10 @@ precommit::use_precommit()
* Run `devtoools::check()` to check for wider package issues like mismatching documentation, etc. (this currently requires a fair bit of time/computation).
* (Optional) Turn on continuous integration with Github Actions on your forked repository.

* On a case-by-case basis, you may be asked to increment the package version both in the `NEWS.md` and
`DESCRIPTION` files. Please do not do this unless you're asked to. We follow the [Tidyverse package versioning guide](https://r-pkgs.org/lifecycle.html). You can run `usethis::use_version()` to automatically
make the changes for you interactively.

### Code style

* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
Expand Down