Also refer to contributing in Carbon.
Go to Carbon for IBM Security's repository on GitHub and fork the repo, syncing with the original repo.
When contributing to Carbon for IBM Security, your work should always be done in a branch off your fork.
- To install the project's dependencies, from the root directory of your fork, run
yarn - To get your development server running and to start coding, run
yarn start
This will start a development server where you can see any changes you are making to components in our Storybook.
Once it's done building, you can edit source code or create new components. The system is set up to automatically bundle your additions / changes. Visit
http://localhost:3000 to see the changes happen on the fly.
If you're contributing to our JavaScript code, test your changes by running our test command, yarn test.
Note: Before you make a pull request, search the issues to see if a similar issue has already been submitted. If a similar issue has been submitted, assign yourself or ask to be assigned to the issue by posting a comment. If the issue does not exist, please make a new issue.
When you're at a good stopping place and you're ready for feedback from other contributors and maintainers, commit, push to your fork, and create a pull request.
See Conventional Commits for more information about how to write your commit message.
Also refer to How to write the perfect pull request.
Stay up to date with the activity in your pull request. Maintainers will be reviewing your work and making comments, asking questions, and suggesting changes to be made before they merge your code.
When you need to make a change, use the same method detailed above.
Once all revisions to your pull request are complete, a maintainer will squash and merge your commits for you.