Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 20 | xraver | 1 | # Contributing to Simple Line Icons |
| 2 | |||
| 3 | First off, thanks for taking the time to contribute! |
||
| 4 | |||
| 5 | The following is a set of guidelines for contributing to Simple Line Icons. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request. |
||
| 6 | |||
| 7 | ## Code of Conduct |
||
| 8 | |||
| 9 | This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to mail@thesabbir.com. |
||
| 10 | |||
| 11 | ## How Can I Contribute? |
||
| 12 | |||
| 13 | - [Reporting bugs](#reporting-bugs) |
||
| 14 | - [Suggestion enhancement](#suggestion-enhancement) |
||
| 15 | - [Pull request](#pull-request) |
||
| 16 | - [Improving documentations](#documentations) |
||
| 17 | |||
| 18 | |||
| 19 | ## Reporting bugs |
||
| 20 | |||
| 21 | Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the problem. |
||
| 22 | |||
| 23 | - Use a clear and descriptive title for the issue to identify the problem. |
||
| 24 | - Describe the exact steps which reproduce the problem. |
||
| 25 | - Explain which behavior you expected to see instead and why. |
||
| 26 | - For visual problems include screenshots which clearly demonstrates the problem. |
||
| 27 | |||
| 28 | Do not forget to mention: |
||
| 29 | |||
| 30 | - Which version of the package are you using. |
||
| 31 | - If the issue is related to installation please mention which method or package manager did you use. |
||
| 32 | |||
| 33 | ## Suggestion Enhancement |
||
| 34 | |||
| 35 | Before creating enhancement suggestions, please check out if a proposal already exists. |
||
| 36 | |||
| 37 | - Mention why you this enhancement is useful. |
||
| 38 | - You can list some other packages where this enhancement exists. |
||
| 39 | |||
| 40 | |||
| 41 | ## Pull Request |
||
| 42 | |||
| 43 | Pull requests are always welcome. We love those! |
||
| 44 | |||
| 45 | - Include screenshot/image if you have added or modified new icon. |
||
| 46 | - We follow [github flow](https://guides.github.com/introduction/flow/) for our development model. |
||
| 47 | - Nice commit messages are always helpful. |
||
| 48 | - Reference issues and pull requests liberally. |
||
| 49 | - If you changed any one styleheet please make sure it reflects all styles file(LESS, CSS, SCSS). |
||
| 50 | |||
| 51 | ## Documentations |
||
| 52 | |||
| 53 | Documentation is currently generated using `generate.php` file from `gh-pages` brunch. |
||
| 54 | |||
| 55 | - Modify `generate.php`. |
||
| 56 | - Run `php generate.php > index.html`. |
||
| 57 | - Do not edit `index.html`. |
||
| 58 | - Documentation should be up-to-date with master. |
||
| 59 | |||
| 60 | ___ |
||
| 61 | |||
| 62 | Unsure where to begin contributing? You can start by looking through these beginner, help-wanted, enhancement labels issues. |
||
| 63 | |||
| 64 | You can [checkout our very cool contributors graph now](https://github.com/thesabbir/simple-line-icons/graphs/contributors). |