readme changes: add note about git flow to readme and contrib vign; o…

…nly edit readme.rmd; install pak change

README.Rmd

@@ -1,3 +1,5 @@
+<!-- Don't edit README.md! Edit README.Rmd, then run `make readme` -->
+
 # sixtyfour
 
 <!-- badges: start -->
@@ -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

README.md

@@ -1,3 +1,5 @@
+<!-- Don't edit README.md! Edit README.Rmd, then run `make readme` -->
+
 # sixtyfour
 
 <!-- badges: start -->
@@ -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

vignettes/contributing.Rmd

@@ -24,27 +24,30 @@ 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
 
 We strive to have all tests that do HTTP requests do so against resources that are not actual AWS accounts given the drawbacks with using real accounts, e.g., setting them up can be difficult at some organizations; forgotten resources can be expensive; accidentally making unwated changes to an account, etc.
 
 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: