Skip to content

Commit

Permalink
Update naming
Browse files Browse the repository at this point in the history
  • Loading branch information
rich-iannone committed Jul 24, 2023
1 parent dda0c55 commit 1dbf318
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 28 deletions.
5 changes: 2 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ There are many ways to contribute to the ongoing development of the **pointblank

## Filing Issues

If you believe you found a bug, create a minimal [reprex](https://reprex.tidyverse.org) for your posting to the [**pointblank** issue tracker](https://github.com/rich-iannone/pointblank/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.
If you believe you found a bug, create a minimal [reprex](https://reprex.tidyverse.org) for your posting to the [**pointblank** issue tracker](https://github.com/rstudio/pointblank/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

Expand All @@ -19,8 +19,7 @@ Should you consider making a pull request (PR), please file an issue first and e
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/rich-iannone/pointblank).
* Look at the GitHub Actions build status badges before and after making changes; these badges are available in the package [README](https://github.com/rstudio/pointblank).
* The **pointblank** 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.
* Add a bullet to the top of `NEWS.md` below the current development version header describing any user-facing changes made; include your GitHub username, and links to relevant issue(s)/PR(s).
8 changes: 2 additions & 6 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@ assignees: rich-iannone

## Prework

* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rich-iannone/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.
* [ ] 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/).
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rstudio/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.

## Description

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ assignees: rich-iannone

## Prework

- [ ] Read and abide by **pointblank**'s [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/.github/CONTRIBUTING.md).
- [ ] Search for duplicates among the [existing issues](https://github.com/rich-iannone/pointblank/issues) (both open and closed).
- [ ] Read and abide by **pointblank**'s [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
- [ ] Search for duplicates among the [existing issues](https://github.com/rstudio/pointblank/issues) (both open and closed).

## Proposal

Expand Down
8 changes: 2 additions & 6 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@ assignees: ''

## Prework

* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rich-iannone/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.
* [ ] For any problems you identify, 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/).
* [ ] Read and agree to the [code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and [contributing guidelines](https://github.com/rstudio/pointblank/blob/main/.github/CONTRIBUTING.md).
* [ ] If there is [already a relevant issue](https://github.com/rstudio/pointblank/issues), whether open or closed, comment on the existing thread instead of posting a new issue.

## Question

Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Thank you for contributing to **pointblank**! To make this process easier for ev
# Checklist

- [ ] I understand and agree to the [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
- [ ] I have listed any major changes in the [NEWS](https://github.com/rich-iannone/pointblank/blob/main/NEWS.md).
- [ ] I have added [`testthat`](https://github.com/r-lib/testthat) unit tests to [`tests/testthat`](https://github.com/rich-iannone/pointblank/tree/main/tests/testthat) for any new functionality.
- [ ] I have listed any major changes in the [NEWS](https://github.com/rstudio/pointblank/blob/main/NEWS.md).
- [ ] I have added [`testthat`](https://github.com/r-lib/testthat) unit tests to [`tests/testthat`](https://github.com/rstudio/pointblank/tree/main/tests/testthat) for any new functionality.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<div align="center">
<br />

<a href='https://rich-iannone.github.io/pointblank/'><img src="man/figures/logo.svg" width="350px"/></a>
<a href='https://rstudio.github.io/pointblank/'><img src="man/figures/logo.svg" width="350px"/></a>

<!-- badges: start -->
<a href="https://cran.r-project.org/package=pointblank"><img src="https://www.r-pkg.org/badges/version/pointblank" alt="CRAN status" /></a>
<a href="https://opensource.org/license/mit/"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
<a href="https://github.com/rich-iannone/pointblank/actions"><img src="https://github.com/rich-iannone/pointblank/workflows/R-CMD-check/badge.svg" alt="R build status" /></a>
<a href="https://github.com/rich-iannone/pointblank/actions"><img src="https://github.com/rich-iannone/pointblank/workflows/lint/badge.svg" alt="Linting" /></a>
<a href="https://app.codecov.io/gh/rich-iannone/pointblank?branch=main"><img src="https://codecov.io/gh/rich-iannone/pointblank/branch/main/graph/badge.svg" alt="Coverage status" /></a>
<a href="https://github.com/rstudio/pointblank/actions"><img src="https://github.com/rstudio/pointblank/workflows/R-CMD-check/badge.svg" alt="R build status" /></a>
<a href="https://github.com/rstudio/pointblank/actions"><img src="https://github.com/rstudio/pointblank/workflows/lint/badge.svg" alt="Linting" /></a>
<a href="https://app.codecov.io/gh/rstudio/pointblank?branch=main"><img src="https://codecov.io/gh/rstudio/pointblank/branch/main/graph/badge.svg" alt="Coverage status" /></a>

<a href="https://bestpractices.coreinfrastructure.org/projects/4310"><img src="https://bestpractices.coreinfrastructure.org/projects/4310/badge" alt="Best Practices"></a>
<a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="The project has reached a stable, usable state and is being actively developed." /></a>
Expand Down Expand Up @@ -292,7 +292,7 @@ informant <-
section_name = "further information",
`examples and documentation` = "Examples for how to use the
`info_*()` functions (and many more) are available at the
[**pointblank** site](https://rich-iannone.github.io/pointblank/)."
[**pointblank** site](https://rstudio.github.io/pointblank/)."
) %>%
incorporate()
```
Expand Down Expand Up @@ -331,7 +331,7 @@ assembly](https://img.shields.io/static/v1?label=Table%20Scan&message=Ensembl:%2
There are many functions available in **pointblank** for understanding data
quality and doing data documentation. Here is an overview of all of them,
grouped by family. For much more information on these, visit the
[documentation website](https://rich-iannone.github.io/pointblank/) or take
[documentation website](https://rstudio.github.io/pointblank/) or take
a *Test Drive* in the [Posit Cloud project](https://rstudio.cloud/project/3411822).

<p align="center">
Expand All @@ -345,7 +345,8 @@ a *Test Drive* in the [Posit Cloud project](https://rstudio.cloud/project/341182
## DISCUSSIONS

Let's talk about data validation and data documentation in
[**pointblank** Discussions](https://github.com/rich-iannone/pointblank/discussions)! It's a great place to ask questions about how to use the package, discuss
[**pointblank** Discussions](https://github.com/rstudio/pointblank/discussions)!
It's a great place to ask questions about how to use the package, discuss
some ideas, engage with others, and much more!

## INSTALLATION
Expand All @@ -359,12 +360,12 @@ install.packages("pointblank")
You can also install the development version of **pointblank** from **GitHub**:

``` r
devtools::install_github("rich-iannone/pointblank")
devtools::install_github("rstudio/pointblank")
```

If you encounter a bug, have usage questions, or want to share ideas to
make this package better, feel free to file an
[issue](https://github.com/rich-iannone/pointblank/issues).
[issue](https://github.com/rstudio/pointblank/issues).

<hr>

Expand Down

0 comments on commit 1dbf318

Please sign in to comment.