Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add template files #77

Merged
merged 7 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributing to elicitr

Thank you for taking the time to contribute to our project. Please, read our [Contributor Code of Conduct](./CODE_OF_CONDUCT.md) to help keep our community friendly and respectful and review this document before filing an issue or opening a PR.

## Questions

If you have a question, please do not file an issue on GitHub but use other channels.

## Issues

Please, before filing and issue check whether it already exists.

Before reporting a **bug** make sure you have the latest version of `elicitr` installed. It is very important to provide a **minimal reproducible example**.
The example should only include code relevant to the problem, so please remove any lines of code not relevant to it.

## Pull Requests

We follow a coding convention. Check out the code in this repository to see the style we use and refer to the [tidyverse guidelines](https://style.tidyverse.org/) for a detailed description of coding conventions.

Before you open a PR it is important that all the following steps can be executed successfully (see the [R Packages](https://r-pkgs.org/) book for details):

1. Start a new R session

2. Load `devtools` with:

```r
library(devtools)
```

3. Load the package with:

```r
load_all()
```

4. Rebuild the documentation with:

```r
document()
```

5. Rebuild the README file with:

```r
build_readme()
```

6. Run R CMD check:

```r
check()
```

7. Run spell check:

```r
spell_check()
```

8. Lint the package:

```r
lintr::lint_package()
```
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "\U0001F41B Bug Report"
about: Use this template for filing a bug report.
title: "[Bug]: "
labels: bug
assignees:
- sgvignali
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: "Describe the bug"
description: "Describe the problem in detail, including errors if any"
validations:
required: true
- type: textarea
id: steps
attributes:
label: "Steps to reproduce the bug"
value: |
library(elicitr)
render: r
validations:
required: true
- type: textarea
id: session
attributes:
label: "Session information"
description: "Please paste the output of `sessionInfo()`"
render: r
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Additional information"
description: "Any other information to help explain your problem"
- type: checkboxes
id: final-step
attributes:
label: "Reproducible example"
options:
- label: "I have done my best to provide the steps to reproduce the bug"
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 🚀 Feature Request
about: Use this template to request a new feature
title: "[Feature request]: "
labels: "new feature"
assignees:
- sgvignali
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a feature request!
Please check if the feature request already exists. If this is the case, instead of creating a duplicate request, please give it a thumbs-up reaction.
If the feature has not yet been filed, then please describe the feature you'd like to see become a part of elicitr.
- type: textarea
id: description
attributes:
label: "Describe the new feature"
validations:
required: true
- type: checkboxes
id: final-step
attributes:
label: "Does the feature request already exist?"
options:
- label: "I have check if the same feature request already exists"
required: true
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/update_doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: "📝 Update Documentation"
description: Use this template for correction needed in the documentation.
title: "[Update Documentation]: "
labels: documentation
assignees:
- sgvignali
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to read and improve the package documentation!
- type: textarea
id: description
attributes:
label: "Explain which part of the documentation should be changed and how to checnge it"
validations:
required: true
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Proposed changes

What types of changes does your code introduce? (Put an `x` in the boxes that apply)

- [ ] Bugfix
- [ ] New feature
- [ ] Documentation update

Please explain the changes you've made here. This will help the maintainers to see why we should accept this pull request. Please, if it does not yet exist, create an issue and be sure to link the PR to that issue.

## Checklist

The first three are required (you can also fill these out after creating the PR).

- [ ] I have read the [contributing](./CONTRIBUTING.md) guidelines
- [ ] All steps described in the contributing guidelines can be executed successfully
- [ ] I have linked the PR to the corresponding issue, see [link a pull request to and issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue)
- [ ] I have added tests that prove my fix is valid or my feature works (if appropriate)
- [ ] I have added the necessary documentation (if appropriate)

💔 Thank you!
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
docs
.Rhistory
.DS_Store
*.html
Loading