Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.59 KB

Contributing to Google Cloud Pub/Sub Operator

Firstly, thank you for considering making a contribution to our project! It's contributions like yours that help make the project better for everyone. This document provides some guidelines to help ensure your contributions are accepted.

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue, including steps to reproduce when it is a bug.
    • Make sure to include the earliest version that you know has the issue.

Making Changes

  • Fork the repository on GitHub.
  • Create a topic branch from where you want to base your work.
    • This is usually the main branch.
    • To quickly create a topic branch: git checkout -b my_contribution
  • Make commits of logical units (if needed rebase your feature branch before submitting it).
  • Make sure your commit messages are well formatted.
  • Make sure you have added the necessary tests for your changes.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository.
  • Update your GitHub issue to mark that you have submitted code and are ready for it to be reviewed (you might also post a link to your pull request).

Additional Resources

Thank you once again for your contribution! We look forward to working together to make the Google Cloud Pub/Sub Operator even better.