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

Use pre commit #1156

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1.
1.
1. ...
2. ...

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ assignees: ''

---

## User - Validation
## User - Validation

+ [ ] First thing to do to validate this as an external user
+ [ ] First thing to do to validate this as an external user
+ [ ] Second thing to do to validate this as an external user

## Dev - Tech
Expand All @@ -30,5 +30,5 @@ _A paragraph that details what this functionality does and how it will be implem
01h00.

+ [ ] Add the estimate as a comment with `/estimate`
+ [ ] When I close this issue, `devtools::check()` is 0 0 0
+ [ ] When I close this issue, `devtools::check()` is 0 0 0
+ [ ] When I close the issue, I've written the time spent solving this issue, using `/spent`
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ doc
Meta
revdep/
README.html
*.Rproj
*.Rproj
17 changes: 17 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-yaml
exclude: ^inst/shinyexample/inst/golem-config.yml$
- id: end-of-file-fixer
- id: trailing-whitespace

- repo: local
hooks:
- id: grkstyle
name: grkstyle
entry: Rscript -e "grkstyle::grk_style_pkg()"
language: system
files: \.R$
types: [file]
12 changes: 6 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

Expand All @@ -13,13 +13,13 @@ imagery, derogatory comments or personal attacks, trolling, public or private ha
insults, or other unprofessional conduct.

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. Project maintainers who do not follow the Code of Conduct may be removed
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http://contributor-covenant.org), version 1.0.0, available at
This Code of Conduct is adapted from the Contributor Covenant
(http://contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
## Contributing
## Contributing

First of all, thank you for taking time to contribute to `{golem}`!

### What you can help with

There are several ways to contribute to the package:
There are several ways to contribute to the package:

1. Spot typos and/or mistakes in the documentations
1. Spot typos and/or mistakes in the documentations

1. Feature requests or Bug Report

1. Contribute the code-base with new features or with bug fixes

### How to contribute

1. For typos, please open an issue or a Pull request with your change.
1. For typos, please open an issue or a Pull request with your change.

For a simple typo, you can PR into the repo without opening an issue first.
You can also only report the typo without doing a PR.
For a simple typo, you can PR into the repo without opening an issue first.
You can also only report the typo without doing a PR.

2. For a new feature or bug report, start by opening an issue on this repo.
2. For a new feature or bug report, start by opening an issue on this repo.

You're welcome to fix the bug or implement the feature, but __please don't PR in the repo with features or bugs correction without opening an issue first so that we can discuss the feature / confirm the bug.__
You're welcome to fix the bug or implement the feature, but __please don't PR in the repo with features or bugs correction without opening an issue first so that we can discuss the feature / confirm the bug.__

### Making change into `{golem}`

1. Fork the repo on your profile.
1. Fork the repo on your profile.

2. `git clone` your repo on your machine.

Expand All @@ -34,21 +34,21 @@ You're welcome to fix the bug or implement the feature, but __please don't PR in
```

3. Work on the `dev` branch.

```
git branch dev
```

Or use the Git panel from RStudio
Or use the Git panel from RStudio

4. Make the changes locally.
4. Make the changes locally.

5. Be sure to have a `devtools::check()` that return 0 errors, 0 warnings and 0 mistakes

```r
devtools::check()
```

If ever you have some errors, please specify it in your commit message / PR comment

6. PR the change __into golem dev branch__, not straight to master
Expand All @@ -69,4 +69,4 @@ options(styler.addins_style_transformer = "grkstyle::grk_style_transformer()")
options(languageserver.formatting_style = function(options) {
grkstyle::grk_style_transformer()
})
```
```
Loading
Loading