mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-18 11:36:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: update contributing

Browse source
This commit is contained in:
Eric Liu 2021-01-22 12:36:10 -08:00
commit 21f01fc3b3
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -1,12 +1,10 @@
# Contributing # Contributing
Note: before submitting a pull request (PR), it is recommended to first [file an issue](https://github.com/IBM/carbon-components-svelte/issues). Before submitting a pull request (PR), consider [filing an issue](https://github.com/IBM/carbon-components-svelte/issues) to gain clarity and direction.
## Prerequisites ## Prerequisites
This project requires Node.js (version 12 or greater) and Yarn (version 1 or greater). - [Node.js](https://nodejs.org/en/download/package-manager/) (version >=12)
- [Node.js](https://nodejs.org/en/download/package-manager/)
- [Yarn](https://classic.yarnpkg.com/en/docs/install) - [Yarn](https://classic.yarnpkg.com/en/docs/install)
## Project set-up ## Project set-up
@ -65,6 +63,12 @@ If linked correctly, any change to a component in the `src` folder should be ref
## Development workflow ## Development workflow
Create a topic branch from `master`. Keep your PR focused and branch up-to-date with upstream `master`.
```sh
git checkout -b new-feature
```
Preview changes to components from the `src` folder in the documentation website located in `docs/`. Preview changes to components from the `src` folder in the documentation website located in `docs/`.
In the `docs` folder, run: In the `docs` folder, run: