diff --git a/README.Rmd b/README.Rmd index 047b70b..6d51351 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,3 +1,5 @@ + + # sixtyfour @@ -13,9 +15,7 @@ A science-focused, more humane R interface to AWS. Development version ```{r eval=FALSE} -if (!requireNamespace("pak", quietly = TRUE)) { - install.packages("pak") -} +# install.packages("pak") pak::pak("getwilds/sixtyfour") ``` @@ -31,7 +31,9 @@ Open an issue on our [issue tracker](https://github.com/getwilds/sixtyfour/issue ## Contributors -See the [Contributing article](http://getwilds.org/sixtyfour/articles/contributing.html) +See the [Contributing article][vigncontrib] + +This package follows [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). See the [Contributing guide] for details. ## Code of Conduct @@ -41,3 +43,4 @@ Please note that the sixtyfour project is released with a [Contributor Code of C [paws]: https://www.paws-r-sdk.com/ [s3fs]: https://dyfanjones.github.io/s3fs/ [minio]: https://min.io/ +[vigncontrib]: http://getwilds.org/sixtyfour/articles/contributing.html diff --git a/README.md b/README.md index ee6ee9a..ad4dee7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # sixtyfour @@ -13,10 +15,8 @@ A science-focused, more humane R interface to AWS. Development version -```r -if (!requireNamespace("pak", quietly = TRUE)) { - install.packages("pak") -} +``` r +# install.packages("pak") pak::pak("getwilds/sixtyfour") ``` @@ -32,7 +32,9 @@ Open an issue on our [issue tracker](https://github.com/getwilds/sixtyfour/issue ## Contributors -See the [Contributing article](http://getwilds.org/sixtyfour/articles/contributing.html) +See the [Contributing article][vigncontrib] + +This package follows [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). See the [Contributing guide] for details. ## Code of Conduct @@ -42,3 +44,4 @@ Please note that the sixtyfour project is released with a [Contributor Code of C [paws]: https://www.paws-r-sdk.com/ [s3fs]: https://dyfanjones.github.io/s3fs/ [minio]: https://min.io/ +[vigncontrib]: http://getwilds.org/sixtyfour/articles/contributing.html diff --git a/vignettes/contributing.Rmd b/vignettes/contributing.Rmd index 7589f6d..aad90e7 100644 --- a/vignettes/contributing.Rmd +++ b/vignettes/contributing.Rmd @@ -24,18 +24,23 @@ reproducible example using [reprex](https://www.tidyverse.org/help/#reprex). Note that this package has a `Makefile` in the root of the repository - see the targets in the `Makefile` for various package maintenance tasks. +### Git Flow + +This package follows [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). In brief, there's two main branches: `main` and `dev`. `main` is considered to be more or less "production-ready" and at any given time should be associated with the most recent release. The `dev` branch has the most recent state of the in development code for the package. When `dev` reaches a state where we're ready for a release, we'll merge `dev` back to `main` and cut a release. When you make a feature branch, please branch off of `dev`. + #### Pull request process * Fork the package and clone onto your computer -* Create a Git branch for your pull request (PR) -* Make your changes, commit to git, and then create a pull request. +* Checkout the `dev` branch +* Create a Git branch off of `dev` for your pull request (PR) +* Make your changes, commit to git, and then create a pull request against `dev`. * The title of your PR should briefly describe the change. * The body of your PR should contain `Fixes #issue-number`. * For user-facing changes, add a bullet to the `NEWS.md` file. #### Code style -* New code should follow the [WILDS style guide](https://getwilds.org/guide/style.html). +* New/edited code should follow the [WILDS style guide](https://getwilds.org/guide/style.html). ## Testing @@ -43,8 +48,6 @@ We strive to have all tests that do HTTP requests do so against resources that a We use two tools to replace real AWS accounts: Minio, Localstack. -### - ### Minio We use [Minio][] for testing two sets of functions in this package for interacting with S3: