CONTRIBUTING.md

Contributing

Hi! We're glad you'd like to contribute to the project. Your help is essential in making this project substantial.

If you are looking to make substantial changes, please open an issue first to discuss with us.

Please note that this project adheres to the code of conduct. By participating in this project, you agree to abide by its rules.

Submitting a pull request

• Fork and clone the repo
• Run bundle install to install all the dependencies
• Make sure the tests are passing bundle exec rake
• Create a new branch: git checkout -b awesome-feature
• Add your changes, tests, and make sure the tests are passing
• Add an entry to the top of CHANGELOG.md
• Push to your fork and submit a pull request

Adding new heroicons

• Copy all icons from the optimized directory in this order:
  • 16/solid -> icons/micro
  • 20/solid -> icons/mini
  • 24/solid -> icons/solid
  • 24/outline -> icons/outline
• After adding the icon(s), run ./bin/compress (you may need to run sudo chmod 755 ./bin/compress)
• Update the CHANGELOG.md
• Submit a pull request adhering to the above mentioned guidelines
• That's it. You have made a significant contribution