Skip to content

Commit a8eb829

Browse files
committed
add .github/ with Contributing, Funding, Issue and PR hints
1 parent 65eea3a commit a8eb829

File tree

5 files changed

+51
-0
lines changed

5 files changed

+51
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
### Contributing to Rcpp
3+
4+
Please see the file [Contributing](https://github.com/RcppCore/Rcpp/blob/master/Contributing.md) for details on
5+
6+
- how to report an issue: a [Minimally Complete (and) Verifiable Example (MCVE)](https://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example) helps a lot;
7+
- how to submit a pull request: post an issue first, get consensus about _what_ and _how_;
8+
- how to follow our (informal) coding style: simply do as other files do and do not invent a new style;
9+
- how to be nice and add [ChangeLog](https://github.com/RcppCore/Rcpp/blob/master/ChangeLog) and [NEWS.Rd](https://github.com/RcppCore/Rcpp/blob/master/ChangeLog).

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: eddelbuettel

.github/ISSUE_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
### Reporting an Issue
3+
4+
_Make use of the *Preview* tab just above!_
5+
6+
#### Before filing an issue with Rcpp, please ensure that you
7+
8+
- searched the mailing list archives for the
9+
[rcpp-devel](https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel) list for the question I want to
10+
ask about; you can do this at at Google with the `site:` qualifier as in this simple example:
11+
`site:lists.r-forge.r-project.org rcpp-devel how do I declare a const vector`;
12+
13+
- searched [StackOverflow](https://stackoverflow.com/) under the `[rcpp]` tag by searching _e.g._ via `[rcpp] how do I sample a vector`;
14+
15+
- searched the existing [GitHub issues](https://github.com/RcppCore/Rcpp/issues) which too can be search among open and
16+
(importantly!) closed ones;
17+
18+
- read the [Contributing](https://github.com/RcppCore/Rcpp/blob/master/Contributing.md) page for details on preferred
19+
reporting and style;
20+
21+
#### If you have the above, remove the text above and provide
22+
23+
- A [`Minimally Complete and Reproducible Example`](https://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example)
24+
25+
- The output of `sessionInfo()` plus relevant information about the C++ compiler used not added by R

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
### Pull Request Template for Rcpp
3+
4+
Please explain the changes you want to apply to Rcpp, preferably in an issue ticket **before** you create a pull
5+
request. See the file [Contributing](https://github.com/RcppCore/Rcpp/blob/master/Contributing.md) and the other
6+
templates for details.
7+
8+
#### Checklist
9+
10+
- [ ] Code compiles correctly
11+
- [ ] `R CMD check` still passes all tests
12+
- [ ] Prefereably, new tests were added which fail without the change
13+
- [ ] Document the changes by file in [ChangeLog](https://github.com/RcppCore/Rcpp/blob/master/ChangeLog)

ChangeLog

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
2019-11-10 Dirk Eddelbuettel <edd@debian.org>
22

3+
* .github/: Add files CONTRIBUTING.md, FUNDING.yml, ISSUE_TEMPLATE.md
4+
and PULL_REQUEST_TEMPLATE.md
5+
36
* inst/include/Rcpp/config.h: Correct RCPP_VERSION and
47
RCPP_DEV_VERSION to 1.0.3
58

0 commit comments

Comments
 (0)