|
| 1 | +# Contributing to the Project |
| 2 | + |
| 3 | +Thank you for your interest in contributing to our project! Here are some guidelines to help you get started. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +### Reporting Bugs |
| 8 | + |
| 9 | +1. **Check for existing issues:** Before reporting a bug, check the issue tracker to see if it has already been reported. |
| 10 | +2. **Create a new issue:** If the bug has not been reported, create a new issue and provide detailed information, including steps to reproduce the bug, screenshots, and any relevant logs. |
| 11 | + |
| 12 | +### Suggesting Enhancements |
| 13 | + |
| 14 | +1. **Check for existing suggestions:** Look through the issue tracker to see if your enhancement has already been suggested. |
| 15 | +2. **Create a new suggestion:** If it hasn't been suggested, open a new issue and describe the enhancement in detail, including its benefits and any potential drawbacks. |
| 16 | + |
| 17 | +### Submitting Pull Requests |
| 18 | + |
| 19 | +1. **Fork the repository:** Create a fork of the repository to work on your changes. |
| 20 | +2. **Make your changes:** Follow the coding standards and guidelines provided in this document. |
| 21 | +3. **Test your changes:** Ensure your changes are thoroughly tested. |
| 22 | +4. **Submit a pull request:** Open a pull request to the main repository and fill out the appropriate template. |
| 23 | + |
| 24 | +#### Submitting a new Icon |
| 25 | + |
| 26 | +1. Follow the exact same steps than [here](###Submitting_Pull_Requests) |
| 27 | +2. **Icon:** Use the placeholder svg to start your Icon. |
| 28 | +3. **Software:** Use Figma or Illustrator for making svg. |
| 29 | + |
| 30 | +Download placeholders: |
| 31 | + |
| 32 | +<a href="./placeholder-dark.svg" download>placeholder-dark.svg</a> |
| 33 | + |
| 34 | +<a href="./placeholder-light.svg" download>placeholder-light.svg</a> |
| 35 | + |
| 36 | +### Coding Standards |
| 37 | + |
| 38 | +- **Style:** Follow the coding style used in the project. |
| 39 | +- **Documentation:** Ensure your code is well-documented. |
| 40 | +- **Commit messages:** Write clear and concise commit messages. |
| 41 | + |
| 42 | +## Code of Conduct |
| 43 | + |
| 44 | +Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project. |
| 45 | + |
| 46 | +## Getting Help |
| 47 | + |
| 48 | +If you need help or have questions, feel free to open an issue or contact one of the project maintainers. |
0 commit comments