|
| 1 | +# Contributing by opening an Issue or Discussing |
| 2 | + |
| 3 | +Whenever you find a bug, which you do not have the time to fix, it is still important |
| 4 | +to get your input. Same goes for feature suggestions and everything else that helps |
| 5 | +a project to get better. |
| 6 | + |
| 7 | +Here are a few points to consider before creating an issue or discussing within one: |
| 8 | + |
| 9 | +1. Make sure you have proper description of your problem or what exactly you want: |
| 10 | + |
| 11 | +We have issue templates in place that should help you with this one and this is really |
| 12 | +important, since we may not just agree with you, if we don't understand your use case. |
| 13 | + |
| 14 | +2. Be constructive and before you post think once more if this is going to waste the maintainers |
| 15 | + time, or if it is going to actually help them. |
| 16 | + |
| 17 | +Since being constructive, is a big vague, here some simple points that should help you: |
| 18 | + |
| 19 | +2.1. Just stating something is wrong, is not constructive. |
| 20 | + |
| 21 | +When you've got the feeling something is wrong, try to understand first if it is really wrong |
| 22 | +and if it is make suggestions on how to improve, or even better open a PR and make the open source |
| 23 | +world once again even better! |
| 24 | + |
| 25 | +2.2. "Does not work", is not a proper problem description |
| 26 | + |
| 27 | +Neither is, "see title". When you follow the issue template and provide all informations asked for |
| 28 | +you should be pretty fine, in providing us exactly the information we need to help you. |
| 29 | + |
| 30 | +2.3. Follow the CoC and contribute, not attack |
| 31 | + |
| 32 | +An example when you're not contributing, but attacking is, should you just impose you're right |
| 33 | +and you should be followed. It is always about the dialogue, that makes the difference. After all |
| 34 | +you should be fine, by just using your common sense. |
| 35 | + |
| 36 | +# Contributing a Pull Request |
| 37 | + |
1 | 38 | Without pull requests from generous people like you, this project
|
2 | 39 | wouldn't be what it is today. You are planning to contribute aren't you?
|
3 | 40 | If so, here's a quick guide to creating a great pull request for
|
|
0 commit comments