|
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +#### Table Of Contents |
| 4 | +* [Getting Started](#getting-started) |
| 5 | +* [How Can I Contribute?](#how-can-i-contribute) |
| 6 | + * [Reporting Bugs](#reporting-bugs) |
| 7 | + * [Suggesting Enhancements](#suggesting-enhancements) |
| 8 | + * [Pull Requests](#pull-requests) |
| 9 | + |
| 10 | +## Getting Started |
| 11 | +* Fork the repository on GitHub |
| 12 | +* Read the [README](README.md) file for build and test instructions |
| 13 | +* Run the examples |
| 14 | +* Explore the the project |
| 15 | +* Submit issues and feature requests, submit changes, bug fixes, new features |
| 16 | + |
| 17 | +## How Can I Contribute? |
| 18 | + |
| 19 | +### Reporting Bugs |
| 20 | + |
| 21 | +Bugs are tracked as |
| 22 | +[GitHub issues](https://github.com/redhat-developer/service-binding-operator/issues). |
| 23 | +Before you log a new bug, review the existing bugs to determine if the problem |
| 24 | +that you are seeing has already been reported. If the problem has not already |
| 25 | +been reported, then you may log a new bug. |
| 26 | + |
| 27 | +Please describe the problem fully and provide information so that the bug |
| 28 | +can be reproduced. Document all the steps that were performed, the |
| 29 | +environment used, include screenshots, logs, and any other information |
| 30 | +that will be useful in reproducing the bug. |
| 31 | + |
| 32 | +### Suggesting Enhancements |
| 33 | + |
| 34 | +Enhancements and requests for new features are also tracked as |
| 35 | +[GitHub issues](https://github.com/redhat-developer/service-binding-operator/issues). |
| 36 | +As is the case with bugs, review the existing feature requests before logging |
| 37 | +a new request. |
| 38 | + |
| 39 | +Please describe the feature request fully and explain the benefits that will |
| 40 | +be derived if the feature is implemented. |
| 41 | + |
| 42 | +### Pull Requests for Code and Documentation |
| 43 | + |
| 44 | +All submitted code and document changes are reviewed by the project |
| 45 | +maintainers through pull requests. |
| 46 | + |
| 47 | +To submit a bug fix or enmhancement, log an issue in github, create a new |
| 48 | +branch in your fork of the repo and include the issue number as a prefix in |
| 49 | +the name of the branch. Include new tests to provide coverage for all new |
| 50 | +or changed code. Create a pull request when you have completed code changes. |
| 51 | +Include an informative title and full details on the code changed/added in |
| 52 | +the git commit message and pull request description. |
| 53 | + |
| 54 | +Before submitting the pull request, verify that all existing tests run |
| 55 | +cleanly by executing unit and e2e tests with this make target: |
| 56 | + |
| 57 | +```bash |
| 58 | +make test |
| 59 | +``` |
| 60 | +Be sure to run yamllint on all yaml files included in pull requests. Ensure |
| 61 | +that all text in files in pull requests is compliant with: |
| 62 | +[.editorconfig](.editorconfig) |
0 commit comments