Skip to content

Commit

Permalink
add contributing file and code-of-conduct files
Browse files Browse the repository at this point in the history
  • Loading branch information
TanguyBarthelemy committed Sep 17, 2024
1 parent 669069f commit ab9846c
Show file tree
Hide file tree
Showing 4 changed files with 136 additions and 62 deletions.
39 changes: 24 additions & 15 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@

.travis.yml
^.*\.Rproj$
^CITATION\.cff$
^LICENSE.md$
^Meta$
^README-.*\.png$
^README\.Rmd$
^\.DS_Store$
^\.Rproj\.user$

^\.git$
^\.github$
^README\.Rmd$
^README-.*\.png$
^Meta$
^docs$
^doc$
^pkgdown$
^_pkgdown\.yml$
^\.httr-oauth$
^\.lintr$
^\.zenodo\.json$
^_pkgdown.yml$
^_pkgdown\.yml$
^appveyor\.yml$
.travis.yml
cran-comments.md
^\.DS_Store$
^revdep$
^reconf\.sh$
^pom\.xml$
^checklist.yml$
^codecov\.yml$
^data-raw$
^dev$
^CITATION\.cff$
^doc$
^docs$
^man-roxygen$
^organisation.yml$
^pkgdown$
^pom\.xml$
^reconf\.sh$
^revdep$
cran-comments.md
25 changes: 25 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behaviour by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http://contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CONTRIBUTING #

### Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the _source_ file.
E.g. edit a `roxygen2` comment in a `.R` file below `R/`, not in an `.Rd` file below `man/`.

### Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem.
If you’ve found a bug, create an associated issue and illustrate the bug with a minimal [reproducible example](https://www.tidyverse.org/help/#reprex).

### Pull request process

* We recommend that you create a Git branch for each pull request (PR).
* Look at the GitHub Actions build status before and after making changes.
The `README` should contain badges for any continuous integration services used by the package.
* We require the `tidyverse` [style guide](http://style.tidyverse.org).
You can use the [`lintr`](https://CRAN.R-project.org/package=lintr) package to check these styles and the [`styler`](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.
* We use [`roxygen2`](https://cran.r-project.org/package=roxygen2).
* We use [`testthat`](https://cran.r-project.org/package=testthat).
Contributions with test cases included are easier to accept.
* For user-facing changes, add a bullet to the top of `NEWS.md` below the current development version (UNRELEASED) header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

### Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project you agree to abide by its terms.

### Prefer to Email?

Email the person listed as maintainer in the `DESCRIPTION` file of this repo.

Though note that private discussions over email don't help others - of course
email is totally warranted if it's a sensitive problem of any kind.

### Thanks for contributing!

This contributing guide is adapted from the `tidyverse` contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md
95 changes: 48 additions & 47 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,58 +1,59 @@
# History files
.Rhistory
.Rapp.history

# Session Data files
.RData
.RDataTmp

# User-specific files
.Ruserdata

# Example code in package build process
*-Ex.R

# Hidden file from mac-os
# History files
# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
# Output files from R CMD build
/*.tar.gz

# Output files from R CMD check
/*.Rcheck/

# R Environment Variables
# RStudio Connect folder
# RStudio files
.Rproj.user/

# produced vignettes
vignettes/*.html
vignettes/*.pdf
Meta/
inst/doc/
doc/

# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth

# knitr and R markdown default cache directories
*_cache/
/cache/

# Session Data files
# Temporary files created by R markdown
*.utf8.md
# User-specific files
# knitr and R markdown default cache directories
# pkgdown site
# produced README.html
# produced vignettes
# translation temp files
*-Ex.R
*.dbf
*.doc*
*.gddoc
*.gdsheet
*.gpkg
*.html
*.knit.md

# R Environment Variables
*.mdb
*.shp*
*.shx
*.utf8.md
*.xls*
*_cache/
*_files
.DS_Store
.RData
.RDataTmp
.Rapp.history
.Renviron

# pkgdown site
.Rhistory
.Rproj.user
.Rproj.user/
.Ruserdata
.httr-oauth
/*.Rcheck/
/*.tar.gz
/cache/
Meta/
README.html
doc/
docs
docs/

# translation temp files
inst/doc/
libs
output
po/*~

# RStudio Connect folder
renv/library
rsconnect/

# Hidden file from mac-os
.DS_Store

# produced README.html
README.html
vignettes/*.html
vignettes/*.pdf

0 comments on commit ab9846c

Please sign in to comment.