Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rsbivand authored Aug 13, 2022
1 parent 374301a commit dd21247
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
### Contributing to rgrass

This outlines how to propose a change to `rgrass` as we move to support [GRASS 8.0](https://github.com/OSGeo/grass). The `rgrass` package is the successor to the `rgrass7` package. The current plan is for `rgrass` to support both GRASS 7 and 8, but for `rgrass7` to be retired.
This outlines how to propose a change to `rgrass` as we move to support [GRASS 8.0](https://github.com/OSGeo/grass). The `rgrass` package is the successor to the `rgrass7` package. `rgrass` supports both GRASS 7 and 8 and is available from CRAN; `rgrass7` will be retired at the latest at the end of 2023 when `rgdal` retires.

### How to propose a change to rgrass

To propose a change to `rgrass`, please consider the roles assigned to the different branches in this repository.

* The `rgrass7` branch is the "target" maintenance source for the package `rgrass7` ("old" package). If you would like to contribute to `rgrass7`, please target your PRs and contributions to this branch.
* The `main` branch is the development branch for `rgrass`. If you would like to contribute to `rgrass` ("new" package), please target your PRs and contributions to this branch.

* The `rgrass` branch is the development branch for moving to support GRASS 8.0. If you would like to contribute to `rgrass` ("new" package), please target your PRs and contributions to this branch.
* The `rgrass7` branch is the "target" maintenance source for the package `rgrass7` ("old" package). If you would like to contribute to `rgrass7`, please target your PRs and contributions to this branch, but note that the package will largely be unusable for file interchange when

* The `main` branch remains the branch for maintenance updates (bug fixes), until support for GRASS 8.0 is achieved (changes on `rgrass7` are merged into `main`).

* Until the `rgrass` branch is ready for release, `main` and `rgrass7` are the same (changes on `rgrass7` are merged into `main`).

* When `rgrass` is ready for submission to CRAN, `rgrass` is merged with `main`, and `rgrass7` will be updated to give a startup message advising users to switch to `rgrass`.
* The next release of `rgrass7` will be updated to give a startup message advising users to switch to `rgrass` and to deprecate all file interchange functionality.

0 comments on commit dd21247

Please sign in to comment.