You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,42 +10,42 @@ Please, make sure you read both of them before contributing, so you can help us
10
10
11
11
## Requesting Support
12
12
13
-
Before you ask a question, it is best to search for existing [issues](https://github.com/enterprise-contract/ec-cli/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
13
+
Before you ask a question, it is best to search for existing issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
14
14
15
15
If you then still feel the need to ask a question and need clarification, we recommend the following:
16
16
17
-
* Open an [issue](https://github.com/enterprise-contract/ec-cli/issues/new).
18
-
* Provide as much context as you can about what you’re running into.
19
-
* Provide project and platform versions (golang, operator-sdk, etc), depending on what seems relevant.
17
+
- Open an issue.
18
+
- Provide as much context as you can about what you’re running into.
19
+
- Provide project and platform versions (golang, operator-sdk, etc), depending on what seems relevant.
20
20
21
21
The community will then take care of the issue as soon as possible.
22
22
23
23
## Reporting Issues
24
24
25
25
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
26
26
27
-
* Open an Issue.
28
-
* Explain the behavior you would expect and the actual behavior.
29
-
* Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
27
+
- Open an Issue.
28
+
- Explain the behavior you would expect and the actual behavior.
29
+
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
30
30
31
31
Once it’s filed:
32
32
33
-
* The project team will label the issue accordingly.
34
-
* A team member will try to reproduce the issue with your provided steps.
35
-
* If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-reproducer`. Bugs with this tag will not be addressed until they are reproduced.
36
-
* If the team is able to reproduce the issue, it will be marked `needs-fix` and left to be implemented by someone. Other labels can be used in addition to better describe the issue or its criticality.
33
+
- The project team will label the issue accordingly.
34
+
- A team member will try to reproduce the issue with your provided steps.
35
+
- If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-reproducer`. Bugs with this tag will not be addressed until they are reproduced.
36
+
- If the team is able to reproduce the issue, it will be marked `needs-fix` and left to be implemented by someone. Other labels can be used in addition to better describe the issue or its criticality.
37
37
38
38
## Requesting Features
39
39
40
40
Enhancement suggestions are tracked as GitHub issues.
41
41
42
-
* Suggest a single enhancement per issue.
43
-
* Provide a clear and descriptive title for the issue to identify what the specific suggestion is.
44
-
* Provide a step-by-step description of the suggested enhancement in as much detail as possible.
45
-
* Describe the current behavior, the expected one, and why you expect this behavior.
46
-
* At this point you can also list which alternatives do not work for you.
47
-
* Explain why this enhancement would be useful to other users.
48
-
* You may also want to point out the other projects that solved it "better" and could serve as inspiration.
42
+
- Suggest a single enhancement per issue.
43
+
- Provide a clear and descriptive title for the issue to identify what the specific suggestion is.
44
+
- Provide a step-by-step description of the suggested enhancement in as much detail as possible.
45
+
- Describe the current behavior, the expected one, and why you expect this behavior.
46
+
- At this point you can also list which alternatives do not work for you.
47
+
- Explain why this enhancement would be useful to other users.
48
+
- You may also want to point out the other projects that solved it "better" and could serve as inspiration.
49
49
50
50
## Submitting Changes
51
51
@@ -65,11 +65,11 @@ All changes must come from a pull request (PR) and cannot be directly committed.
65
65
66
66
Before a pull request can be merged:
67
67
68
-
* The content of the PR has to be relevant to the PR itself
69
-
* The contribution must follow the style guidelines of this project
70
-
* Multiple commits should be used if the PR is complex and clarity can be improved, but they should still relate to a single topic
71
-
* For code contributions, tests have to be added/modified to ensure the code works
72
-
* There has to be at least one approval
73
-
* The feature branch must be rebased so it contains the latest changes from the target branch
74
-
* The CI has to pass successfully
75
-
* Every comment has to be addressed and resolved
68
+
- The content of the PR has to be relevant to the PR itself
69
+
- The contribution must follow the style guidelines of this project
70
+
- Multiple commits should be used if the PR is complex and clarity can be improved, but they should still relate to a single topic
71
+
- For code contributions, tests have to be added/modified to ensure the code works
72
+
- There has to be at least one approval
73
+
- The feature branch must be rebased so it contains the latest changes from the target branch
0 commit comments