Skip to content

Commit fdfc6f7

Browse files
committed
Merge branch 'barbara/contributing'
2 parents 3121d2c + 065c288 commit fdfc6f7

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,38 @@
1-
21
We welcome contributions to the **shiny** package. To submit a contribution:
32

43
1. [Fork](https://github.com/rstudio/shiny/fork) the repository and make your changes.
54

6-
2. Ensure that you have signed the [individual](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioIndividualContributorAgreement.pdf) or [corporate](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioCorporateContributorAgreement.pdf) contributor agreement as appropriate. You can send the signed copy to [email protected].
5+
2. If the change is non-trivial, ensure that you have signed the [individual](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioIndividualContributorAgreement.pdf) or [corporate](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioCorporateContributorAgreement.pdf) contributor agreement as appropriate. You can send the signed copy to [email protected]. For trivial changes (like typo fixes), a contributor agreement is not needed.
76

87
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests).
98

10-
We'll try to be as responsive as possible in reviewing and accepting pull requests. We appreciate your contributions!
9+
We generally do not merge pull requests that update included web libraries (such as Bootstrap or jQuery) because it is difficult for us to verify that the update is done correctly; we prefer to update these libraries ourselves.
10+
11+
12+
## How to make changes
13+
14+
Before you submit a pull request, please do the following:
15+
16+
* Add an entry to NEWS.md concisely describing what you changed.
17+
18+
* If appropriate, add unit tests in the tests/ directory.
19+
20+
* If you made any changes to the JavaScript files in the srcjs/ directory, make sure you build the output JavaScript files. See tools/README.md file for information on using the build system.
21+
22+
* Run Build->Check Package in the RStudio IDE, or `devtools::check()`, to make sure your change did not add any messages, warnings, or errors.
23+
24+
Doing these things will make it easier for the Shiny development team to evaluate your pull request. Even so, we may still decide to modify your code or even not merge it at all. Factors that may prevent us from merging the pull request include:
25+
26+
* breaking backward compatibility
27+
* adding a feature that we do not consider relevant for Shiny
28+
* is hard to understand
29+
* is hard to maintain in the future
30+
* is computationally expensive
31+
* is not intuitive for people to use
32+
33+
We will try to be responsive and provide feedback in case we decide not to merge your pull request.
34+
35+
36+
## Filing issues
37+
38+
If you find a bug in Shiny, you can also [file an issue](https://github.com/rstudio/shiny/issues/new). Please provide as much relevant information as you can, and include a minimal reproducible example if possible.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ devtools::install_version("shiny", version = "0.10.2.2")
5959

6060
The Javascript code in Shiny is minified using tools that run on Node.js. See the tools/ directory for more information.
6161

62+
## Guidelines for contributing
63+
64+
We welcome contributions to the **shiny** package. Please see our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed guidelines of how to contribute.
65+
6266
## License
6367

6468
The shiny package is licensed under the GPLv3. See these files in the inst directory for additional details:

0 commit comments

Comments
 (0)