You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 1.6 KiB

1234567891011121314151617181920212223242526272829303132
  1. Want to contribute? Great! First, read this page (including the small print at the end).
  2. ### Before you contribute
  3. Before we can use your code, you must sign the
  4. [Google Individual Contributor License Agreement]
  5. (https://cla.developers.google.com/about/google-individual)
  6. (CLA), which you can do online. The CLA is necessary mainly because you own the
  7. copyright to your changes, even after your contribution becomes part of our
  8. codebase, so we need your permission to use and distribute your code. We also
  9. need to be sure of various other things—for instance that you'll tell us if you
  10. know that your code infringes on other people's patents. You don't have to sign
  11. the CLA until after you've submitted your code for review and a member has
  12. approved it, but you must do it before we can put your code into our codebase.
  13. Before you start working on a larger contribution, you should get in touch with
  14. us first through the issue tracker with your idea so that we can help out and
  15. possibly guide you. Coordinating up front makes it much easier to avoid
  16. frustration later on.
  17. ### Code reviews
  18. All submissions, including submissions by project members, require review. We
  19. use Github pull requests for this purpose.
  20. ### Breaking code changes
  21. When a breaking change is added, CI/CD will fail. If the change is expected,
  22. add a BREAKING_CHANGE_ACCEPTABLE=<reason> line to the CL description. This will
  23. cause CI/CD to skip checking breaking changes.
  24. ### The small print
  25. Contributions made by corporations are covered by a different agreement than
  26. the one above, the
  27. [Software Grant and Corporate Contributor License Agreement]
  28. (https://cla.developers.google.com/about/google-corporate).