[WIP] documentation for getting started in developing shiny #4260
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
schloerke
reviewed
Aug 4, 2025
| @@ -0,0 +1,126 @@ | |||
| # Contributing to Shiny | |||
There was a problem hiding this comment.
For my education, why did the file move? Both locations are valid.
The PR location clutters the top level. The main location is hidden in the .github folder.
Both files will notify a PR about an updated contributing guide when making a PR.
There was a problem hiding this comment.
This file will need to be included within .Rbuildignore
There was a problem hiding this comment.
Given other GitHub files are hidden in the .github folder, I'm inclined to keep it in its original location.
|
|
||
| * If appropriate, add unit tests in the tests/ directory. | ||
|
|
||
| * 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. |
There was a problem hiding this comment.
Suggested change
| * 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. | |
| * If you made any changes to the JavaScript files in the `srcts/` directory, make sure you build the output JavaScript files. See `tools/README.md` file for information on using the build system. |
|
|
||
| ### Setup: JavaScript / TypeScript | ||
|
|
||
| You will need to have [node.js](https://nodejs.org/en/download) installed.np |
There was a problem hiding this comment.
Suggested change
| You will need to have [node.js](https://nodejs.org/en/download) installed.np | |
| You will need to have [node.js](https://nodejs.org/en/download) installed. |
Comment on lines
+57
to
+67
| #### yarn | ||
|
|
||
| ```bash | ||
| # Download and install Yarn: | ||
| corepack enable yarn | ||
|
|
||
| # Verify Yarn version: | ||
| yarn -v | ||
| ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
Gutting usage of yarn in #4252
Suggested change
| #### yarn | |
| ```bash | |
| # Download and install Yarn: | |
| corepack enable yarn | |
| # Verify Yarn version: | |
| yarn -v | |
| ``` |
| #### Install dependencies | ||
|
|
||
| ```bash | ||
| yarn install --immutable |
There was a problem hiding this comment.
Suggested change
| yarn install --immutable | |
| npm ci |
| If in the future you want to upgrade or add a package, run: | ||
|
|
||
| ```bash | ||
| yarn add --dev [packagename] |
There was a problem hiding this comment.
Suggested change
| yarn add --dev [packagename] | |
| npm install --save-dev --save-exact [packagename] |
| yarn add --dev [packagename] | ||
| ``` | ||
|
|
||
| This will automatically add the package to the dependencies in `package.json`, and it will also update the `yarn.lock` to reflect that change. If someone other than yourself does this, simply run `yarn` to update your local packages to match the new `package.json`. |
There was a problem hiding this comment.
Suggested change
| This will automatically add the package to the dependencies in `package.json`, and it will also update the `yarn.lock` to reflect that change. If someone other than yourself does this, simply run `yarn` to update your local packages to match the new `package.json`. | |
| This will automatically add the package to the dependencies in `package.json`, and it will also update the `package-lock.json` to reflect that change. If someone other than yourself does this, simply run `npm ci` to update your local packages to match the new `package.json`. |
|
|
||
| This will automatically add the package to the dependencies in `package.json`, and it will also update the `yarn.lock` to reflect that change. If someone other than yourself does this, simply run `yarn` to update your local packages to match the new `package.json`. | ||
|
|
||
| ### Upgrading packages |
There was a problem hiding this comment.
Please copy latest from #4252 once it's merged. Thank you!
|
|
||
| ```bash | ||
| npm install https://github.com/rstudio/shiny\#v1.11.1 --save-dev | ||
| # or |
| npm install https://github.com/rstudio/shiny\#v1.11.1 --save-dev | ||
| # or | ||
| yarn add https://github.com/rstudio/shiny\#v1.11.1 --dev | ||
| yarn add shiny@https://github.com/rstudio/shiny\#v1.11.1 --dev |
There was a problem hiding this comment.
Suggested change
| yarn add shiny@https://github.com/rstudio/shiny\#v1.11.1 --dev |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.