CONTRIBUTING.md

In CorrelAid/pocketapi: Wrapper Around the 'Pocket' API

Contributing to pocketapi

You're welcome to propose a change to pocketapi.

Prerequisites

Before making any substantial changes to pocketapi with a pull request, please file an issue first describing the problem so that someone from the project team can look into it and confirm that it needs adaptation. If you want to report a bug, please provide a minimal reprex to make the issue reproducible for the developers.

Pull request process

• Please create a Git branch for your pull request (PR).
• make sure the badges in the README before and after making changes to ensure everything is still working as expected.
• Please provide tests in the tests folder. This makes it easier for us to accept your PR.
• Please format your code using the styler package before committing it.
• If you're change is user-facing (e.g. changing function parameters), include a bullet to the top of NEWS.md below the current development version header describing the changes made followed by your GitHub username and links to relevant issue(s)/PR(s).

The following code of conduct is to be respected.

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 behavior 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 behavior 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/

CorrelAid/pocketapi documentation built on Feb. 25, 2021, 4:07 p.m.