|
1 |
| -= Contributing to robotframework-gradle-plugin |
| 1 | += Contributing to workflow-dispatch-action |
2 | 2 | :toc:
|
| 3 | +:toc-placement!: |
| 4 | +:gh_repo: https://github.com/mathze/workflow-dispatch-action |
3 | 5 |
|
4 | 6 | 👍🎉 First off, thanks for taking the time to contributing 🎉👍
|
| 7 | +Any kind of contribution is welcome😊 |
| 8 | + |
| 9 | +toc::[] |
5 | 10 |
|
6 | 11 | == Code of conduct
|
7 | 12 | This project and everyone participating in it is governed by the link:CODE_OF_CONDUCT.adoc[Code of Conduct]
|
| 13 | + |
| 14 | +== Found a bug? |
| 15 | +* Ensure the bug was not already reported by searching our {gh_repo}/issues[issues] |
| 16 | +* Check for an existing {gh_repo}/discussions[discussion] on your issue |
| 17 | +* If you're unable to find an open issue addressing the problem by creating a {gh_repo}/issues/new?assignees=&labels=&template=bug_report.md&title=[new bug ticket] |
| 18 | + |
| 19 | +== Found a security vulnerability? |
| 20 | +Please refer to our link:SECURITY.adoc[SECURITY] advisory |
| 21 | + |
| 22 | +== Have an improvement idea? |
| 23 | +Very cool! Let's get it into the project! |
| 24 | + |
| 25 | +* First make sure your idea isn't already addressed by a {gh_repo}/issues[feature request] or already in {gh_repo}/discussions[discussion] |
| 26 | +* If a feature request already exists and no one is assigned to it, you can leaf a comment on it that you are interested in work on it or vote for it (see <<Working with issues>>) |
| 27 | +* If there is a discussion about your idea, participate in it. |
| 28 | +* If neither a discussion nor a feature request exists, feel free to create a {gh_repo}/issues/new?assignees=&labels=&template=enhancement.md&title=[new feature request] |
| 29 | + |
| 30 | +== Working with issues |
| 31 | +To keep the information of any issue on its essentials, please respect the following guidelines: |
| 32 | + |
| 33 | +* any discussion shall take place in {gh_repo}/discussions/categories/issues[discuss an issue]. There is no "`golden rule`" from when a discussion in an issue get out of hand, and a discussion should be opened. But a rule of thumb is: "If there are any conflictive opinions, open a discussion" |
| 34 | +* If a discussion about an issue exists it shall be linked. |
| 35 | +* Discussions about an issue must have the issue's id within its title |
| 36 | +* Us 👍 or 👎 on the issue (not a single comment, see <<Discussions on issues>>) to up/down vote it. + |
| 37 | +Note:: Do not add comments like "+1", "-1", "Want that", "Disagree"; Such comments will be deleted. |
| 38 | + |
| 39 | +== Discussions |
| 40 | +{gh_repo}/discussions[Here] is the place where you can share your ideas, ask or answer questions. |
| 41 | + |
| 42 | +=== Discussions on issues |
| 43 | +To up or down vote an idea/comment, use 👍 or 👎 respectively. Avoid cluttering the discussion with "+1", "-1", "like", "dislike" etc. comments. + |
| 44 | +If you write a comment, it should provide value to the discussion. |
| 45 | + |
| 46 | +== Code review |
| 47 | +This project encourages actively reviewing the code, as it will store your precious data, so it's common practice to receive comments on provided patches. |
| 48 | + |
| 49 | +If you are reviewing other contributor's code please consider the following when reviewing: |
| 50 | + |
| 51 | +* Be nice. Please make the review comment as constructive as possible so all participants will learn something from your review. |
| 52 | + |
| 53 | +As a contributor, you might be asked to rewrite portions of your code to make it fit better into the upstream sources. |
0 commit comments