Skip to content

Commit

Permalink
Merge pull request #1 from slu-openGIS/cranRelease
Browse files Browse the repository at this point in the history
Cran release
  • Loading branch information
Christopher Prener authored Sep 12, 2018
2 parents aeeae32 + d918e88 commit 828e3cb
Show file tree
Hide file tree
Showing 33 changed files with 992 additions and 59 deletions.
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
^\.Rproj\.user$
^README\.Rmd$
^README-.*\.png$
^CONDUCT\.md$
^\.travis\.yml$
^\.travis$
^codecov\.yml$
Expand All @@ -12,3 +11,4 @@
^_pkgdown\.yml$
^\.zenodo\.json$
^LICENSE$
^.github$
76 changes: 76 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race,
religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the package maintainer
[Christopher Prener, Ph.D.](mailto:[email protected]}). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Complaints involving
members of the Saint Louis University community may be forwarded to the Office of
Institutional Equity and Diversity. The project team is obligated to maintain
confidentiality with regard to the reporter of an incident unless otherwise
obligated to report that incident to Saint Louis University.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
91 changes: 91 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Contributing to this Lesson
Thanks for using this package. Before filing an issue or opening a pull
request, there are a few places to explore and pieces to put together to make
the process as smooth as possible.

## Getting Started
Start by making a minimal reproducible example (**reprex**) using the
[reprex](http://reprex.tidyverse.org/) package. If you haven't heard of or used
reprex before, you're in for a treat! 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). For additional reprex
pointers, check out the [Get help!](https://www.tidyverse.org/help/) section of
the tidyverse site.

Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask).

* If it's a question: start with [community.rstudio.com](https://community.rstudio.com/).
There are more people there to answer questions.
* If it's a bug: you're in the right place, file an issue.
* If it's a feature request: you're in the right place, file an issue.
* If you're not sure: let the community help you figure it out! If your
problem _is_ a bug or a feature request, you can easily return here and
report it. You can use our _other inquiry_ issue template to get our
feedback.

## Before Opening an Issue
Before opening a new issue, be sure to [search issues and pull requests][issuesLink]
to make sure the bug or typo hasn't been reported and/or already fixed.
Similarly, search to make sure someone has not already made a suggestion. If
there is a suggestion and you want to express support for it, please comment
in the existing issue.

By default, the search will be pre-populated with `is:issue is:open`. You can
[edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/)
(e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply
remove `is:open` to search _all_ issues in the repo, open or closed.

## Issue Templates
When you go to open an issue, you are encouraged to select from one of the
three templates: bug reports, feature requests, or other inquiries. These will
help you craft an issue that is as helpful and clear as possible!

## PR process
If you've found a way to contribute, please follow the PR process described
here to fork, edit, and push your proposed changes. We recommend opening an
issue to gauge our interest before spending time working on a PR!

### Fork, clone, branch
The first thing you'll need to do is to [fork](https://help.github.com/articles/fork-a-repo/)
[this lesson][repoLink], and then clone it locally.
We recommend that you create a branch for each PR.

### Style
Match the existing code or documentation style. Be careful to only make style changes
to the code you are contributing.

### Document
Make sure to update the help files if your changes impact
any of those documents. If you add a new package dependency, please also update
the `DESCRIPTION` file so that the dependency is part of our continuous integration
testing.

### Check
Once you are done, make sure that all changed `.Rmd` documents knit without error.

### Commit
When you've made your changes, write a clear commit message describing what
you've done. If you've fixed or closed an issue, make sure to include keywords
(e.g. `fixes #101`) at the end of your commit message (not in its
title) to automatically close the issue when the PR is merged.

### Push and pull
Once you've pushed your commit(s) to a branch in _your_ fork, you're ready to
make the pull request. Pull requests should have descriptive titles to remind
reviewers/maintainers what the PR is about. You can easily view what exact
changes you are proposing using either the [Git diff](http://r-pkgs.had.co.nz/git.html#git-status)
view in RStudio, or the [branch comparison view](https://help.github.com/articles/creating-a-pull-request/)
you'll be taken to when you go to create a new PR. If the PR is related to an
issue, provide the issue number and slug in the _description_ using
auto-linking syntax (e.g. `#15`).

## Code of Conduct
Please note that this project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to
abide by its terms.

## Acknowledgements
These contributing guidelines are modified from those used by [Jenny Bryan](https://github.com/jennybc).

[repoLink]: https://github.com/slu-openGIS/qualmap
[issuesLink]: https://github.com/slu-openGIS/qualmap/issues
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help me address a problem

---

**Before you open your issue:**
* All issues and contributions are covered by the [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
* Please check out the [Contribution guidelines](/.github/CONTRIBUTING.md)

**Describe the bug**
A clear and concise description of what the bug is.

**Expected behavior**
A clear and concise description of what you expected to happen.

**To Reproduce**
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>. When you create your reprex, please use a data set available in a package.

```r
# inset reprex here
```

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. macOS]
- Version of R [e.g. v3.5.1]
- Version of RStudio [e.g. v1.1.453]

**Additional context**
Add any other context about the problem here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Before you open your issue:**
* All issues and contributions are covered by the [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
* Please check out the [Contribution guidelines](/.github/CONTRIBUTING.md)

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Provide a reprex**
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>. When you create your reprex, please use a data set available in a package.

```r
# inset reprex here
```

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/other-inquiry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Other inquiry
about: Ask a question or give me some feedback

---

**Before you open your issue:**
* All issues and contributions are covered by the [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
* Please check out the [Contribution guidelines](/.github/CONTRIBUTING.md)

**Is your inquiry related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Provide a reprex**
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>. When you create your reprex, please use a data set available in a package.

```r
# inset reprex here
```
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
**Before you open your pull request:**

* All issues and contributions are covered by the [Code of Conduct](/.github/CODE_OF_CONDUCT.md)
* Please check out the [Contribution guidelines](/.github/CONTRIBUTING.md)

**Describe your contribution** Please describe the changes you are suggestion. If these are in response to specific issues, please link to them by using the `#15` syntax where `15` is the issue number.
Loading

0 comments on commit 828e3cb

Please sign in to comment.