Skip to content

Commit 752c0d2

Browse files
juliasilgejuliasilge
committed
Update CoC, pkgdown, README, NEWS, etc
1 parent cb2f07c commit 752c0d2

7 files changed

+144
-17
lines changed

‎.github/CODE_OF_CONDUCT.md

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
125+
126+
[homepage]: https://www.contributor-covenant.org

‎DESCRIPTION

+8-6
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ Authors@R: c(
66
comment = c(ORCID = "0000-0002-3671-836X")),
77
person("RStudio", role = c("cph", "fnd"))
88
)
9-
Description: The goal of 'vetiver' is to provide fluent tooling to version,
10-
share, deploy, and monitor a trained model. Functions handle both
11-
recording and checking the model's input data prototype, and
9+
Description: The goal of 'vetiver' is to provide fluent tooling to
10+
version, share, deploy, and monitor a trained model. Functions handle
11+
both recording and checking the model's input data prototype, and
1212
predicting from a remote API endpoint. The 'vetiver' package is
1313
extensible, with generics that can support many kinds of models.
1414
License: MIT + file LICENSE
1515
URL: https://vetiver.tidymodels.org/,
1616
https://github.com/tidymodels/vetiver
1717
BugReports: https://github.com/tidymodels/vetiver/issues
18+
Depends:
19+
R (>= 3.4)
1820
Imports:
1921
butcher,
2022
cli,
@@ -52,10 +54,10 @@ Suggests:
5254
testthat (>= 3.0.0),
5355
workflows,
5456
xgboost
55-
Config/Needs/website:
56-
tidyverse/tidytemplate
57+
VignetteBuilder:
58+
knitr
59+
Config/Needs/website: tidyverse/tidytemplate
5760
Config/testthat/edition: 3
5861
Encoding: UTF-8
5962
Roxygen: list(markdown = TRUE)
6063
RoxygenNote: 7.1.2
61-
VignetteBuilder: knitr

‎NEWS.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# vetiver (development version)
22

3+
* Update all tests to use redaction for snapshots.
4+
35
# vetiver 0.1.2
46

57
* Generate Dockerfiles to deploy model (#71).

‎README.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ knitr::opts_chunk$set(
1616
# vetiver 🏺
1717

1818
<!-- badges: start -->
19-
[![R-CMD-check](https://github.com/tidymodels/vetiver/workflows/R-CMD-check/badge.svg)](https://github.com/tidymodels/vetiver/actions)
19+
[![R-CMD-check](https://github.com/tidymodels/vetiver/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/vetiver/actions/workflows/R-CMD-check.yaml)
2020
[![CRAN status](https://www.r-pkg.org/badges/version/vetiver)](https://CRAN.R-project.org/package=vetiver)
2121
[![Codecov test coverage](https://codecov.io/gh/tidymodels/vetiver/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/vetiver?branch=main)
2222
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
@@ -135,7 +135,7 @@ predict(endpoint, new_sac)
135135

136136
## Contributing
137137

138-
This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
138+
This project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
139139

140140
- For questions and discussions about modeling packages, modeling, and machine learning, please [post on RStudio Community](https://community.rstudio.com/new-topic?category_id=15&tags=tidymodels,question).
141141

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<!-- badges: start -->
77

8-
[![R-CMD-check](https://github.com/tidymodels/vetiver/workflows/R-CMD-check/badge.svg)](https://github.com/tidymodels/vetiver/actions)
8+
[![R-CMD-check](https://github.com/tidymodels/vetiver/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/vetiver/actions/workflows/R-CMD-check.yaml)
99
[![CRAN
1010
status](https://www.r-pkg.org/badges/version/vetiver)](https://CRAN.R-project.org/package=vetiver)
1111
[![Codecov test
@@ -149,7 +149,7 @@ predict(endpoint, new_sac)
149149
## Contributing
150150

151151
This project is released with a [Contributor Code of
152-
Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
152+
Conduct](https://www.contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
153153
By contributing to this project, you agree to abide by its terms.
154154

155155
- For questions and discussions about modeling packages, modeling, and

‎_pkgdown.yml

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ template:
66
danger: "#CA225E"
77
primary: "#CA225E"
88
package: tidytemplate
9+
includes:
10+
in_header: |
11+
<script defer data-domain="vetiver.tidymodels.org,all.tidymodels.org" src="https://plausible.io/js/plausible.js"></script>
12+
913
1014
development:
1115
mode: auto

‎cran-comments.md

-7
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
This is the 3rd CRAN release of vetiver. This release adds support for several important model types (glm, ranger), as well as the ability to generate Dockerfiles for deployment.
44

5-
## Test environments
6-
7-
* GitHub Actions (ubuntu-18.04): devel, release, oldrel
8-
* GitHub Actions (windows): release, oldrel
9-
* GitHub Actions (macOS): release
10-
* win-builder: devel
11-
125
## R CMD check results
136

147
0 errors | 0 warnings | 0 notes

0 commit comments

Comments
 (0)