Skip to content

Commit cd89e8c

Browse files
committed
Remove issue link from CONTRIBUTING.md
Removed issue link from CONTRIBUTING.md as this file is repository agnostic. Signed-off-by: Rob Nester <rnester@redhat.com>
1 parent 7866eda commit cd89e8c

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,42 @@ Please, make sure you read both of them before contributing, so you can help us
1010

1111
## Requesting Support
1212

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.
1414

1515
If you then still feel the need to ask a question and need clarification, we recommend the following:
1616

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.
2020

2121
The community will then take care of the issue as soon as possible.
2222

2323
## Reporting Issues
2424

2525
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
2626

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.
3030

3131
Once it’s filed:
3232

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.
3737

3838
## Requesting Features
3939

4040
Enhancement suggestions are tracked as GitHub issues.
4141

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.
4949

5050
## Submitting Changes
5151

@@ -65,11 +65,11 @@ All changes must come from a pull request (PR) and cannot be directly committed.
6565

6666
Before a pull request can be merged:
6767

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
74+
- The CI has to pass successfully
75+
- Every comment has to be addressed and resolved

0 commit comments

Comments
 (0)