Skip to content

Commit b2410ad

Browse files
batpigandmehadley
authored andcommitted
Add tidy github and LICENSE.md (#484)
1 parent 5191392 commit b2410ad

10 files changed

+153
-1
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@
1717
^appveyor\.yml$
1818
^\.github$
1919
^\.httr-oauth$
20+
^LICENSE\.md$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/CODE_OF_CONDUCT.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who
4+
contribute through reporting issues, posting feature requests, updating documentation,
5+
submitting pull requests or patches, and other activities.
6+
7+
We are committed to making participation in this project a harassment-free experience for
8+
everyone, regardless of level of experience, gender, gender identity and expression,
9+
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
10+
11+
Examples of unacceptable behavior by participants include the use of sexual language or
12+
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
13+
insults, or other unprofessional conduct.
14+
15+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
16+
commits, code, wiki edits, issues, and other contributions that are not aligned to this
17+
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
18+
from the project team.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
21+
opening an issue or contacting one or more of the project maintainers.
22+
23+
This Code of Conduct is adapted from the Contributor Covenant
24+
(https://www.contributor-covenant.org), version 1.0.0, available at
25+
https://contributor-covenant.org/version/1/0/0/.

.github/CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing to haven
2+
3+
This outlines how to propose a change to haven.
4+
For more detailed info about contributing to this, and other tidyverse packages, please see the
5+
[**development contributing guide**](https://rstd.io/tidy-contrib).
6+
7+
## Fixing typos
8+
9+
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file.
10+
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file.
11+
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
12+
13+
## Bigger changes
14+
15+
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed.
16+
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
17+
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
18+
19+
### Pull request process
20+
21+
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("batpigandme/haven", fork = TRUE)`.
22+
23+
* Install all development dependences with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
24+
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
25+
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
26+
27+
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
28+
The title of your PR should briefly describe the change.
29+
The body of your PR should contain `Fixes #issue-number`.
30+
31+
* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.
32+
33+
### Code style
34+
35+
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
36+
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.
37+
38+
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html), for documentation.
39+
40+
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
41+
Contributions with test cases included are easier to accept.
42+
43+
## Code of Conduct
44+
45+
Please note that the haven project is released with a
46+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
47+
project you agree to abide by its terms.
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Bug report or feature request
3+
about: Describe a bug you've seen or make a case for a new feature
4+
---
5+
6+
Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://community.rstudio.com/>.
7+
8+
Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
9+
10+
Brief description of the problem
11+
12+
```r
13+
# insert reprex here
14+
```

.github/SUPPORT.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Getting help with haven
2+
3+
Thanks for using haven!
4+
Before filing an issue, there are a few places to explore and pieces to put together to make the process as smooth as possible.
5+
6+
## Make a reprex
7+
8+
Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) package.
9+
If you haven't heard of or used reprex before, you're in for a treat!
10+
Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about).
11+
For additional reprex pointers, check out the [Get help!](https://www.tidyverse.org/help/) section of the tidyverse site.
12+
13+
## Where to ask?
14+
15+
Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask).
16+
17+
* If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), and/or StackOverflow. There are more people there to answer questions.
18+
19+
* If it's a bug: you're in the right place, [file an issue](https://github.com/batpigandme/haven/issues/new).
20+
21+
* If you're not sure: let the community help you figure it out!
22+
If your problem _is_ a bug or a feature request, you can easily return here and report it.
23+
24+
Before opening a new issue, be sure to [search issues and pull requests](https://github.com/batpigandme/haven/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
25+
By default, the search will be pre-populated with `is:issue is:open`.
26+
You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed.
27+
For example, you'd simply remove `is:open` to search _all_ issues in the repo, open or closed.
28+
29+
## What happens next?
30+
31+
To be as efficient as possible, development of tidyverse packages tends to be very bursty, so you shouldn't worry if you don't get an immediate response.
32+
Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there’s a burst of intense activity as we focus our efforts.
33+
That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you.
34+
This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it.
35+
If we can’t reproduce the bug, we can’t fix it!

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
YEAR: 2013-2016
1+
YEAR: 2013-2019
22
COPYRIGHT HOLDER: Hadley Wickham; RStudio; and Evan Miller

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 Hadley Wickham; RStudio; and Evan Miller
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.Rmd

+4
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,7 @@ write_dta(mtcars, "mtcars.dta")
9090

9191
* [sas7bdat](https://cran.r-project.org/package=sas7bdat) reads from
9292
SAS7BDAT files.
93+
94+
## Code of Conduct
95+
96+
Please note that the haven project is released with a [Contributor Code of Conduct](https://haven.tidyverse.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,7 @@ write_dta(mtcars, "mtcars.dta")
8787

8888
- [sas7bdat](https://cran.r-project.org/package=sas7bdat) reads from
8989
SAS7BDAT files.
90+
91+
## Code of Conduct
92+
93+
Please note that the haven project is released with a [Contributor Code of Conduct](https://haven.tidyverse.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

0 commit comments

Comments
 (0)