|
| 1 | +# css-inline contribution guidelines |
| 2 | + |
| 3 | +Thank you for your interest in making `css-inline` better! |
| 4 | +We'd love to have your contribution. We expect all contributors to |
| 5 | +abide by the [Contributor Covenant Code of Conduct], which you can find in the |
| 6 | +[`CODE_OF_CONDUCT.md`] file in this repository. |
| 7 | + |
| 8 | +[`CODE_OF_CONDUCT.md`]: https://github.com/Stranger6667/css-inline/blob/master/CODE_OF_CONDUCT.md |
| 9 | + |
| 10 | +## License |
| 11 | + |
| 12 | +The code in this project is licensed under MIT license. |
| 13 | +By contributing to `css-inline`, you agree that your contributions will be licensed under its MIT license. |
| 14 | + |
| 15 | +## Pull Requests |
| 16 | + |
| 17 | +To make changes to `css-inline`, please send in pull requests on GitHub to the `master` |
| 18 | +branch. We'll review them and either merge or request changes. Github Actions test |
| 19 | +everything as well, so you may get feedback from it too. |
| 20 | + |
| 21 | +If you make additions or other changes to a pull request, feel free to either amend |
| 22 | +previous commits or only add new ones, however you prefer. We may ask you to squash |
| 23 | +your commits before merging, depending. |
| 24 | + |
| 25 | +## Feature requests and feedback |
| 26 | + |
| 27 | +If you'd like to suggest a feature, feel free to `submit an issue <https://github.com/Stranger6667/css-inline/issues>`_ |
| 28 | +and: |
| 29 | + |
| 30 | +* Write a simple and descriptive title to identify your suggestion. |
| 31 | +* Provide as many details as possible, explain your context, and how the feature should work. |
| 32 | +* Explain why this improvement would be useful. |
| 33 | +* Keep the scope narrow. It will make it easier to implement. |
| 34 | + |
| 35 | +## Report bugs |
| 36 | + |
| 37 | +Report bugs for `css-inline` in the `issue tracker <https://github.com/Stranger6667/css-inline/issues>`_. |
| 38 | + |
| 39 | +If you are reporting a bug, please: |
| 40 | + |
| 41 | +* Write a simple and descriptive title to identify the problem. |
| 42 | +* Describe the exact steps which reproduce the problem in as many details as possible. |
| 43 | +* Describe the behavior you observed after following the steps and point out the problem with that behavior. |
| 44 | +* Explain which behavior you expected to see instead and why. |
| 45 | +* Include your Rust and `css-inline` version. Additionally include your Python version if you use our Python bindings. |
| 46 | + |
| 47 | +It would be awesome if you can submit a failing test that demonstrates the problem. |
| 48 | + |
| 49 | +## Running tests |
| 50 | + |
| 51 | +Running tests requires a Flask app running in background: |
| 52 | + |
| 53 | +``` |
| 54 | +python -m pip install flask |
| 55 | +python ./css-inline/tests/server.py & |
| 56 | +``` |
| 57 | + |
| 58 | +Then run tests inside the `css-inline` directory: |
| 59 | + |
| 60 | +``` |
| 61 | +cargo test |
| 62 | +``` |
| 63 | + |
| 64 | +## Preferred communication language |
| 65 | + |
| 66 | +We prefer to keep all communications in English. |
0 commit comments