-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
use Apache license + GH contribution templates
- Loading branch information
1 parent
5fd0935
commit 9cb6de1
Showing
11 changed files
with
445 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,3 +16,4 @@ ignore/* | |
^README\.html$ | ||
^inst/examples/data\.qmd$ | ||
^inst/examples/text\.qmd$ | ||
^LICENSE\.md$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in | ||
our community a harassment-free experience for everyone, regardless of | ||
age, body size, visible or invisible 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. | ||
|
||
We pledge to act and interact in ways that contribute to an open, | ||
welcoming, diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our | ||
mistakes, and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political | ||
attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our | ||
standards of acceptable behavior and will take appropriate and fair | ||
corrective action in response to any behavior that they deem | ||
inappropriate, threatening, offensive, or harmful. | ||
|
||
Community leaders 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, and will | ||
communicate reasons for moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also | ||
applies when an individual is officially representing the community in | ||
public spaces. Examples of representing our community include using an | ||
official e-mail address, posting via an official social media account, | ||
or acting as an appointed representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may | ||
be reported to the community leaders responsible for enforcement at | ||
[rich@posit.co](mailto:rich@posit.co). All complaints will be reviewed and | ||
investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security | ||
of the reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in | ||
determining the consequences for any action they deem in violation of | ||
this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior | ||
deemed unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, | ||
providing clarity around the nature of the violation and an explanation | ||
of why the behavior was inappropriate. A public apology may be | ||
requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, for a specified period of | ||
time. This includes avoiding interactions in community spaces as well as | ||
external channels like social media. Violating these terms may lead to a | ||
temporary or permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, | ||
including sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No | ||
public or private interaction with the people involved, including | ||
unsolicited interaction with those enforcing the Code of Conduct, is | ||
allowed during this period. Violating these terms may lead to a | ||
permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of | ||
individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction | ||
within the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the | ||
[Contributor Covenant][homepage], version 2.1, available at | ||
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see the FAQ | ||
at https://www.contributor-covenant.org/faq. Translations are available | ||
at https://www.contributor-covenant.org/translations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Information and Guidelines for Contributing to **tabulapdf** | ||
|
||
There are many ways to contribute to the ongoing development of the **tabulapdf** package. Some contributions can be rather easy to do (e.g., fixing typos, improving documentation, filing issues for feature requests or problems, etc.) whereas other contributions can require more time and patience (like answering questions and submitting pull requests with code changes). Just know that that help provided in any capacity is very much appreciated. :) | ||
|
||
## Filing Issues | ||
|
||
If you believe you found a bug, create a minimal [reprex](https://reprex.tidyverse.org) for your posting to the [**tabulapdf** issue tracker](https://github.com/ropensci/tabulapdf/issues). Try not to include anything unnecessary, just the minimal amount of code that constitutes the reproducible bug. We will try to verify the bug by running the code in the reprex provided. The quality of the reprex will reduce the amount of back-and-forth communication in trying to understand how to execute the code on our systems. | ||
|
||
## Answering questions | ||
|
||
A great way to help is by simply answering questions. It's amazing how a little conversation could lead to better insights on a problem. Don't quite know the answer? That's okay too. We're all in this together. | ||
|
||
Where might you answer user questions? Some of the forums for Q&A on **tabulapdf** include the [RStudio community](https://community.rstudio.com), on Twitter (a good search term is `tabulapdf #rstats`), and on [Stack Overflow](https://stackoverflow.com). Good etiquette is key during these interactions: be a good person to all who ask questions. | ||
|
||
### Making Pull Requests | ||
|
||
Should you consider making a pull request (PR), please file an issue first and explain the problem in some detail. If the PR is an enhancement, detail how the change would make things better for package users. Bugfix PRs also requre some explanation about the bug and how the proposed fix will remove that bug. A great way to illustrate the bug is to include a [reprex](https://reprex.tidyverse.org). While all this upfront work prior to preparing a PR can be time-consuming it opens a line of communication with the package authors and the community, perhaps leading to better enhancement or more effective fixes! | ||
|
||
Once there is consensus that a PR based on the issue would be helpful, adhering to the following process will make things proceed more quickly: | ||
|
||
* Create a separate Git branch for each PR. | ||
* Look at the GitHub Actions build status badges before and after making changes; these badges are available in the package [README](https://github.com/ropensci/tabulapdf). | ||
* The **tabulapdf** package follows the tidyverse [style guide](http://style.tidyverse.org) so please adopt those style guidelines in your submitted code as best as possible. | ||
* The internal documentation uses [roxygen2](https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html); if your contribution requires new or revised documentation ensure that the roxygen comments are added/modified (do not modify any `.Rd` files in the `man` folder). | ||
* We use [testthat](https://cran.r-project.org/web/packages/testthat/) for code coverage; those contributions with test cases included are helpful easier to accept. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: Bug | ||
about: Something is wrong with tabulapdf. | ||
title: '' | ||
labels: 'Type: ☹︎ Bug' | ||
assignees: pachadotdev | ||
--- | ||
|
||
## Prework | ||
|
||
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/ropensci/freedomhouse/blob/main/.github/CONTRIBUTING.md). | ||
* [ ] If there is [already a relevant issue](https://github.com/ropensci/freedomhouse/issues), whether open or closed, comment on the existing thread instead of posting a new issue. | ||
|
||
## Description | ||
|
||
Describe the bug clearly and concisely. | ||
|
||
## Reproducible example | ||
|
||
* [ ] Post a [minimal reproducible example](https://www.tidyverse.org/help/) so the maintainer can troubleshoot the problems you identify. A reproducible example is: | ||
* [ ] **Runnable**: post enough R code and data so any onlooker can create the error on their own computer. | ||
* [ ] **Minimal**: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand. | ||
* [ ] **Readable**: format your code according to the [tidyverse style guide](https://style.tidyverse.org/). | ||
|
||
## Expected result | ||
|
||
What should have happened? Please be as specific as possible. | ||
|
||
## Session info | ||
|
||
End the reproducible example with a call to `sessionInfo()` in the same session (e.g. `reprex(session_info = TRUE)`) and include the output. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: New feature | ||
about: Suggest a new feature. | ||
title: '' | ||
labels: 'Type: ★ Enhancement' | ||
assignees: pachadotdev | ||
--- | ||
|
||
## Prework | ||
|
||
- [ ] Read and abide by **tabulapdf**'s [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/ropensci/tabulapdf/blob/main/.github/CONTRIBUTING.md). | ||
- [ ] Search for duplicates among the [existing issues](https://github.com/ropensci/tabulapdf/issues) (both open and closed). | ||
|
||
## Proposal | ||
|
||
Describe the new feature clearly and concisely. If applicable, write a minimal example in R code or pseudo-code to show input, usage, and desired output. | ||
|
||
To help us read any code you include (optional) please try to follow the [tidyverse style guide](https://style.tidyverse.org/). The `style_text()` and `style_file()` functions from the [`styler`](https://github.com/r-lib/styler) package make it easier. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Question | ||
about: Ask a question. | ||
title: '' | ||
labels: 'Type: ⁇ Question' | ||
assignees: '' | ||
--- | ||
|
||
## Prework | ||
|
||
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [contributing guidelines](https://github.com/ropensci/tabulapdf/blob/main/.github/CONTRIBUTING.md). | ||
* [ ] If there is [already a relevant issue](https://github.com/ropensci/tabulapdf/issues), whether open or closed, comment on the existing thread instead of posting a new issue. | ||
|
||
## Question | ||
|
||
What would you like to know? | ||
|
||
## Reproducible example | ||
|
||
* [ ] For any problems you identify, post a [minimal reproducible example](https://www.tidyverse.org/help/) so the maintainer can troubleshoot. A reproducible example is: | ||
* [ ] **Runnable**: post enough R code and data so any onlooker can create the error on their own computer. | ||
* [ ] **Minimal**: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand. | ||
* [ ] **Readable**: format your code according to the [tidyverse style guide](https://style.tidyverse.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Summary | ||
|
||
Thank you for contributing to **tabulapdf**! To make this process easier for everyone, please explain the context and purpose of your contribution. Also, list the changes made to the existing code or documentation. | ||
|
||
# Related GitHub Issues and PRs | ||
|
||
- Ref: # | ||
|
||
# Checklist | ||
|
||
- [ ] I understand and agree to the [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). | ||
- [ ] I have listed any major changes in the [NEWS](https://github.com/ropensci/tabulapdf/blob/main/NEWS.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.