Skip to content

Commit e4a6228

Browse files
wchbborgesr
authored andcommitted
Edits to contribution guidelines
1 parent 8c3dbe2 commit e4a6228

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

CONTRIBUTING.md

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

2-
Shiny is an open source project and we occasionally accept pull requests from outside contributors. These range from simple typo fixes to more complicated multi-file PRs. *The bar for us to merge a PR gets increasingly higher the more code you are changing or adding.*
3+
1. [Fork](https://github.com/rstudio/shiny/fork) the repository and make your changes.
34

4-
We'll try to be as responsive as possible in reviewing and accepting pull requests. We appreciate your contributions!
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.
56

6-
### Trivial changes
7-
For very trivial PRs (like typo fixes), you don't need to do anything else except submit the PR with a one-line explanation of what you are fixing. If you never forked and submitted a pull request to a repository before, you may benefit from reading [this guide](https://gist.github.com/Chaser324/ce0505fbed06b947d962). In very broad strokes, you need to [fork](https://github.com/rstudio/shiny/fork) the repository, make your changes and then submit a [pull request](https://help.github.com/articles/about-pull-requests/).
7+
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests).
88

9-
*Note*: We tend not to accept library update PRs (for example, a PR that updates Shiny to the latest version of Bootstrap or font-awesome). Since these can sometimes break previous examples and apps, we prefer to always do the updating ourselves.
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.
1010

11-
### Non-trivial changes
12-
For pretty much everything else, before you submit your PR, you need to:
1311

14-
- Check your code by running `devtools::check()` to make sure you did not add any messages, warnings or errors. This also checks to make sure that you've added all relevant documentation, that the DESCRIPTION and NAMESPACE files are up-to-date, etc.
12+
## How to make changes
1513

16-
- Test your code if needed, preferably through unit tests (which go in the "tests" folder).
14+
Before you submit a pull request, please do the following:
1715

18-
- If you made any changes to the JS files in the "srcjs" directory, make sure you run `grunt` (from the terminal, navigate to the "tools" directory and enter the command `grunt`).
16+
* Add an entry to NEWS.md concisely describing what you changed.
1917

20-
- Add a [NEWS.md](https://github.com/rstudio/shiny/blob/master/NEWS.md) entry (in the appropriate section) concisely describing what you changed.
18+
* If appropriate, add unit tests in the tests/ directory.
2119

22-
- Be responsive to the Shiny team's feedback on your PR.
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.
2321

24-
If you do these things, it makes our lives a lot easier and lets us judge the merit of your PR without worrying about all the boilerplate associated with changes to existing code. However, we may still decide to modify your code somewhat or even not merge it at all. There are a lot of factors at play here, including whether or not your change:
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.
2523

26-
- breaks backward compatibility;
27-
- adds a feature that we do not consider relevant for Shiny;
28-
- is computationally expensive;
29-
- is hard to maintain in the future;
30-
- is intuitive for people to use and incorporate in their apps.
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:
3125

32-
We will always try to be responsive and provide feedback in case we decide not to merge your PR.
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
3332

34-
### RStudio Contributor Agreement
35-
If we do decide to merge your non-trivial PR, you have one more step to complete, which is to **sign 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 only have to do this once (the first time you contribute), so if you've contributed in the past, we should still have your agreement on file.
33+
We will try to be responsive and provide feedback in case we decide not to merge your pull request.
3634

37-
This is necessary to let us make changes to the license in the future (for example, to change to a BSD license if GPL becomes a problem, or a later GPL version). If you're OK with that, then sign the form, scan it and email it to [email protected].
3835

39-
### Filing issues is also a valuable contribution!
40-
If you notice a bug or you think of a new feature that you'd like to see in Shiny, you can also [file an issue](https://github.com/rstudio/shiny/issues/new). This is ideal when you don't know how you'd solve the problem or even if you have an idea of how to do so, but you prefer to leave the coding up to us. Issues are actually an extremely helpful contribution, so don't hesitate to do so.
36+
## Filing issues
4137

42-
When you file an issue, please give as much information as you can (for example, if you think you know what is causing the bug, you could link to the appropriate file and line). Also, please provide a minimal reproducible example if appropriate (pretty much every time you're reporting a bug). This will allow us to quickly understand what's the problem and how we can fix it.
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.

0 commit comments

Comments
 (0)