Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

84 lines (54 loc) · 2.61 KB
Raw

How to Contribute

We'd like to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

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.

Code of Conduct

Participation in this project comes under the Contributor Covenant Code of Conduct

Submitting code via Pull Requests

  • We follow the GitHub Pull Request Model for all contributions.
  • All submissions, including submissions by project members, will require review before being merged.
  • Thanks for considering submitting code!

Coding standards

When submitting pull requests, make sure to do the following:

  • Format all code
  • Remove trailing whitespace. Many editors will do this automatically.
  • Ensure any new files have a trailing newline

Getting Started

  1. Clone the repo (Typically the first step is to fork the repo, but forking is currently disabled.)

    git clone https://github.com/googleforgames/gaming-specialists-samples.git

  2. Move into the repo's base directory.

    cd gaming-specialists-samples

  3. Create a new branch for you to start your work.

    git checkout -b 'name-of-your-branch'

  4. Add your code, make updates, etc.

  5. When you're ready to push your code back to the repo, add your files, commit, then push.

    # Add file(s)
git add your-file-to-add.txt

# Commit 
git commit -m 'Add your commit message here'

# Push
git push origin 'name-of-your-branch'

  6. Go to the repo on Github

  7. Click "Compare & pull request".

  8. Complete the Pull Request for (see pull_request_template.md).

  9. Be sure to add a reviewer to your PR.

  10. Submit the PR and wait for reviews.

  11. Once the PR has been approved, it's safe to merge (or auto-merging may happen if that is enabled).

  12. Best practice is to delete your branch once your PR has been approved.