Skip to content
This repository has been archived by the owner on Apr 25, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
58 lines (47 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
58 lines (47 loc) · 2.65 KB
Raw

Private Copies Of The Code

You can fork the StarThinker repository and create your own private team repo to customize the code. You are NOT required nor obligated to contribute back your changes to the open source repository. The code is covered by Apache License 2.0 giving you full ability to use and modify this code for any purpose including commercial use.

READ BELOW ONLY IF YOU CHOOSE TO CONTRIBUTE BACK TO THE OPEN SOURCE REPOSITORY...

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

How to Contribute

Create a fork which makes a copy of the code in your own private repository that you can modify as needed. Make the changes, commit them to your private repository. Then perform a Pull Request which will present the commits you chose to the main StarThinker open source repository for review.

Before the Pull Request can be accepted and merged, there are a few requirements to clear:

  • Obtain a peer review and approval for your code by another human person, including StarThinker maintainers if you don't have anyone you can ask to.
    • The person reviewing your code should confirm that the code does what it is intended to do, and that it doesn't "cut corners" to do that.
  • Once you have obtained approval, a bot will generate a request for the StarThinker maintainers. Wait for the maintainers to review the code and work on any change that might be requested by them.
  • Once the request is accepted by the maintainers, a bot will sync the code to StarThinker internal repository and eventually merge and close the Pull Request.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub Pull Requests for this purpose. Consult GitHub Help for more information on using pull requests.