Skip to content

Commit

Permalink
Create CODE_OF_CONDUCT.md (omnideconv#50)
Browse files Browse the repository at this point in the history
* Create CODE_OF_CONDUCT.md

* Create CONTRIBUTING.md
  • Loading branch information
grst authored Jul 24, 2020
1 parent 098727f commit 6586736
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 0 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 both within project spaces and in public spaces
when an individual is representing the project or its community. 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 [email protected]. 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
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

We welcome contributions to immunedeconv!

## Filing an issue

Bug reports and feature requests are indispensible for improving immunedeconv. To make them as useful as possible:

* Search the repository to see if someone has already reported the same issue.
This allows contributors to spend less time responding to issues, and more time adding new features!
* Please provide a minimal complete verifiable example for any bug.
If you're not sure what this means, check out
[this blog post](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
by Matthew Rocklin or [this definition](https://stackoverflow.com/help/mcve) from StackOverflow.
* Let us know about your environment. Environment information is available via `sessionInfo()`.

## Contributing code

We are absolutely enthusiastic about code contributions! If you prepare a PR, we'd like you to follow
the following guidelines:

### Tests
Please write tests! We use [`testthat`](https://testthat.r-lib.org/) to ensure the package works correctly.
You can refer to the [existing test suite](https://github.com/icbi-lab/immunedeconv/tree/master/tests)
and the [Testing chapter from the R packages book](http://r-pkgs.had.co.nz/tests.html) when adding new tests.

### Documentation
When adding a new function, make sure you write appropriate documentation. We make use
of [roxygen2](https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html) to
document functions and [pkgdown](https://pkgdown.r-lib.org/) to render the documentation website.

* The roxygen2 docstring should describe what the function is doing (try to think about it from
the prespective of the user).
* The docstring should describe all parameters and return values.
* Consider adding an example to one of the [vignettes](https://github.com/icbi-lab/immunedeconv/tree/master/vignettes).

0 comments on commit 6586736

Please sign in to comment.