Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.54 KB
Raw

How to become a contributor and submit your own code

Patches welcome

Your changes and ideas are welcome and appreciated. Please do not hesitate to ask a question or send a PR.

All changes must be reviewed. We require that all changes get at least one review, preferably from someone familiar with the areas the change touches. For non-trivial changes, we may want two reviewers. In these instances, the primary reviewer should make this decision and nominate a second reviewer. As this is not a corporate sponsored project, please allow for a reasonable time to look at PR, relevant to open issues and pull requests.

Thank you for your contribution(s)!

Contributing A Patch

  1. Submit an issue describing your proposed change.
  2. A community member will respond to your issue promptly.
  3. Fork the desired repo, develop and test your code changes.
  4. Submit a pull request.

Adding a new API endpoint

When adding a new API endpoint, please be sure to include the following:

  • README.md - A summation of the api endpoint(s) we're emulating with links to the documentation
  • tests - testing is highly valued in this project. Please test at the service level, but also add to the integration test for Cerulean in tests/
  • Detail in your PR which API versions you're including

Meetings

We meet every 2 weeks to discuss road map or discuss open issues. Please join us at: https://meet.google.com/suc-ozkk-uvv

Meeting Notes: https://docs.google.com/document/d/1WrV0vRXVPat4M3k5ABe-zlJnDRig9PvIj_513mnKri8/edit?usp=sharing