Skip to content

Latest commit

 

History

History
102 lines (59 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

102 lines (59 loc) · 2.46 KB

Contribution Guidelines for jis3r/icons

First off all, thanks for taking the time to contribute! ❤️

The following is a set of guidelines for contributing to jis3r/icons. Feel free to propose changes to this document in a pull request.

Pull Requests

Feel free to open a pull-request to contribute to this project.

Working on your first Pull Request? You can learn how from this free series

How to Contribute to an Open Source Project on GitHub

Guidelines for pull requests:

  • Make your commit messages as descriptive as possible. Include as much information as you can. Explain anything that the file diffs themselves won’t make apparent.

  • Document your pull request. Explain your fix, link to the relevant issue, add screenshots when adding new icons.

  • Make sure the target of your pull request is the relevant branch. Most of bugfix or new feature should go to the main branch.

  • Include only related work. If your pull request has unrelated commit, it won't be accepted.

Icon Guidelines

  • Icon names should be in kebab-case. For example, arrow-up or chevron-left.

  • Icon names must be dentical to their lucide counterpart.

  • Icons must be added as .svelte components.

  • Icons must be added to the src/lib/icons directory.

  • Only use vanilla CSS to create the animations. No libraries like svelte-motion.

Icon Requests

Before creating an icon request, please search to see if someone has requested the icon already. If there is an open request, please add a 👍.

Development

To contribute to the project, follow these steps:

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

git clone https://github.com/your-username/icons.git
  1. Navigate to the project directory:
cd icons
  1. Create a new branch for your feature or bug fix:
git checkout -b your-branch-name
  1. Install the project dependencies:
npm i

  1. Make your changes to the codebase.

  2. Build the project:

npm run build
  1. Test the application to ensure your changes work as expected.
npm run build
npm run preview
  1. Commit your changes:
git commit -m "Your commit message"
  1. Push your changes to your fork:
git push origin your-branch-name
  1. Open a pull request on the original repository.

Thank you for contributing to the project!