Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

33 lines (19 loc) · 2.07 KB

Contributing

How to become a GCP Project contributor

Code of Conduct

As contributors and maintainers of this GCP Project Operator, we do respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. In short, be excellent to each other.

Finding issues to work on

  • "good-first-issue - issues where they are easy to complete even for beginners

  • "help wanted" - issues where we currently have no resources to work on them as there are other pressing matters

Once you've discovered an issue to work on:

  • Add a comment mentioning that you plan to work on this issue and assign it to yourself.
  • Send a PR out that mentions the issue in the commit message.

Contributing A Patch

If you are new to open-source contribution, please read the this guide to get yourself familiar with the basics.

Writing tests

As a best practice, the project requires tests to be submitted at the same PR with the code. If you are developing a new feature, please remember writting tests for it as well. See the relevant testing documenation

An example PR template

Here is a PR template which can be used by contributors. After having both /lgtm and /approve labels from approvers and reviewers, your PR will be merged by Openshift Merge Bot To prevent any accidental merge, marking the PR as work in progress by adding the [WIP] tag would be nice