|
| 1 | + |
| 2 | +# Contributing |
| 3 | +Thank you so much for your interest in contributing! All types of contributions are encouraged and valued. The Project Team looks forward to your contributions. |
| 4 | + |
| 5 | +## Filing issues |
| 6 | +When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed. |
| 7 | +Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing](https://help.github.com/articles/subscribing-to-conversations/) to the issue. |
| 8 | + |
| 9 | +If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project (or gist) that reproduces the problem. |
| 10 | + |
| 11 | + |
| 12 | +## Contributing code |
| 13 | +We actively welcome your pull requests. You can find instructions on building the project in [README.md](https://github.com/canopas/rich-editor-swiftui). |
| 14 | +1. Fork the repo and create your branch from `main`. |
| 15 | +2. If you've added code that should be tested, add tests |
| 16 | +4. Make sure your code lints. |
| 17 | + |
| 18 | +## Labels |
| 19 | +Labels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean: |
| 20 | + |
| 21 | + * **bug**: feature that should work, but doesn't |
| 22 | + * **enhancement**: minor tweak/addition to existing behaviour |
| 23 | + * **feature**: new behaviour, bigger than enhancement |
| 24 | + * **question**: no need of any fix, usually a usage problem |
| 25 | + * **reproducible**: has enough information to very easily reproduce, mostly in the form of a small project in a GitHub repo |
| 26 | + * **repro-needed**: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do |
| 27 | + * **duplicate**: there's another issue which already covers/tracks this |
| 28 | + * **wontfix**: working as intended, or won't be fixed due to compatibility or other reasons |
| 29 | + * **invalid**: there isn't enough information to make a verdict, or unrelated |
| 30 | + * **non-library**: issue is not in the core library code, but rather in documentation, samples, build process, releases |
| 31 | + |
| 32 | + ## License |
| 33 | + By contributing to RichEditorSwiftUI, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details. |
0 commit comments