Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ranghetti committed May 13, 2019
1 parent 58c98d9 commit 985a21c
Show file tree
Hide file tree
Showing 8 changed files with 320 additions and 29 deletions.
76 changes: 76 additions & 0 deletions CONDUCT.md
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
13 changes: 12 additions & 1 deletion README.Rmd
Expand Up @@ -18,10 +18,11 @@ knitr::opts_chunk$set(
```

[![Travis-CI Build Status](https://travis-ci.org/ranghetti/sen2r.svg?branch=master)](https://travis-ci.org/ranghetti/sen2r)
[![Docker Build Status](https://img.shields.io/docker/build/ranghetti/sen2r.svg)](https://hub.docker.com/r/ranghetti/sen2r)
![Docker Automated build](https://img.shields.io/docker/automated/ranghetti/sen2r.svg)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1240384.svg)](https://doi.org/10.5281/zenodo.1240384)
[![CRAN Status](http://www.r-pkg.org/badges/version/sen2r)](https://cran.r-project.org/package=sen2r)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
[![Contributor Covenant](http://sen2r.ranghetti.info/https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CONDUCT.html)

<img src="man/figures/sen2r_logo_200px.png" width="200" height="113" align="right" />

Expand Down Expand Up @@ -177,3 +178,13 @@ Ranghetti, L.\ and Busetto, L.\ (`r strftime(Sys.Date(),"%Y")`). *sen2r: an R to
url = {http://sen2r.ranghetti.info},
}
```

## Contributing

This project is released with a [Contributor Code of Conduct](http://sen2r.ranghetti.info/CONDUCT.html).
By participating in this project you agree to abide by its terms.

Users are encouraged to use GitHub issues in case of errors with the package.
Before opening a new issue, please read
<a href="https://github.com/ranghetti/sen2r/issues/186" target="_blank">these notes</a>.

10 changes: 9 additions & 1 deletion README.md
Expand Up @@ -3,10 +3,11 @@
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [Contributing](#contributing)

<!-- IMPORTANT: do NOT edit README.Rmd! Edit index.Rmd instead, -->
<!-- and generate README.Rmd using inst/extdata/code/create_README.sh -->
[![Travis-CI Build Status](https://travis-ci.org/ranghetti/sen2r.svg?branch=master)](https://travis-ci.org/ranghetti/sen2r) [![Docker Build Status](https://img.shields.io/docker/build/ranghetti/sen2r.svg)](https://hub.docker.com/r/ranghetti/sen2r) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1240384.svg)](https://doi.org/10.5281/zenodo.1240384) [![CRAN Status](http://www.r-pkg.org/badges/version/sen2r)](https://cran.r-project.org/package=sen2r) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
[![Travis-CI Build Status](https://travis-ci.org/ranghetti/sen2r.svg?branch=master)](https://travis-ci.org/ranghetti/sen2r) ![Docker Automated build](https://img.shields.io/docker/automated/ranghetti/sen2r.svg) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1240384.svg)](https://doi.org/10.5281/zenodo.1240384) [![CRAN Status](http://www.r-pkg.org/badges/version/sen2r)](https://cran.r-project.org/package=sen2r) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Contributor Covenant](http://sen2r.ranghetti.info/https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CONDUCT.html)

<img src="man/figures/sen2r_logo_200px.png" width="200" height="113" align="right" />

Expand Down Expand Up @@ -101,3 +102,10 @@ Ranghetti, L. and Busetto, L. (2019). *sen2r: an R toolbox to find, download a
url = {http://sen2r.ranghetti.info},
}
```

Contributing
------------

This project is released with a [Contributor Code of Conduct](http://sen2r.ranghetti.info/CONDUCT.html). By participating in this project you agree to abide by its terms.

Users are encouraged to use GitHub issues in case of errors with the package. Before opening a new issue, please read <a href="https://github.com/ranghetti/sen2r/issues/186" target="_blank">these notes</a>.
181 changes: 181 additions & 0 deletions docs/CONDUCT.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 8 additions & 12 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 985a21c

Please sign in to comment.