Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 1.92 KB

Contributing

New Icon requests or contributions

To contribute new icons or request new icons please reach out to [email protected]

Documentation

To work on this project's documentation first install the project on your local machine:

  1. Node Version Manager's for your system.
  2. Navigate to your project folder
cd red-hat-icons
  1. Run Node Version Manager's use command to switch to the projects Node version.
nvm use

If prompted, follow the instructions for installing specific version of Node used by this project on your system, which will look similar to the following:

You need to run "nvm install v20.10.0" to install it before using it.

  1. Install project dependencies, run npm ci
npm ci
  1. Start the development server
npm run serve
  1. Make your changes and commit

Adding Icons

To add new icons, first obtain approval from [email protected]

  1. Setup the project locally, steps 1-4 above.
  2. Once your project setup make changes to the files then run a build
npm run build

Your svg files will then be compressed and optimized, new artifacts will be generated in ./dist 3. Check your work in the demo

npm run serve
  1. Commit your changes.

Commit Changes

  1. Commit your changes using conventional commits style.
  2. Add a changeset
npx changeset

For more information about changesets and how to use them please read the changeset documentation. 3. Open a new PR and request team members for review.