Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

39 lines (34 loc) · 2.15 KB

Contributing

  • We welcome any Pull Requests that help the Apigee community. Our focus is:
    • reference code that can be used by others to solve a specific problem
    • labs that are intended to teach others about specific features
    • tools that automate a specific task or improve productivity
  • Projects should be small and simple. A 10 line bash script is often easier to understand and maintain than a full NodeJS app!
  • We follow the Google Open Source Community Guidelines
  • We pride ourselves on the high quality of this repository. Therefore we ask each contribution to have accompanying tests with thorough coverage to help meet this goal.

Quickstart

  • Fork the repository and make your contribution - please don't make changes to multiple projects in the same Pull Request!
  • Ensure that your project has a pipeline.sh in the root of your project - see here for more
  • Put the Apache 2.0 license header in your source files (you might automate this!)
  • New projects, need a line in the CODEOWNERS file to declare ownership
  • Create a Pull Request with a description of your contribution
  • At this stage, CI will run the below Pull Request Checks and we will do code reviews
  • Once any issues found are resolved, your change will be merged!

Pull Request Checks