Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 2.7 KB
Raw

How to contribute

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

Contributor License Agreement

Contributions to any Google project must be accompanied by a Contributor License Agreement. This is not a copyright assignment, it simply gives Google permission to use and redistribute your contributions as part of the project.

When submitting a pull request, if you have not already signed the Contributor License Agreement (CLA), then a bot will remind you. Code cannot even be evaluated without this step.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it.

  4. All contributions must be licensed Apache 2.0 and all files must have a copy of the boilerplate licence comment (can be copied from an existing file). Files should be formatted according to Google's java style guide.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Finally, push the commits to your fork and submit a pull request.

Merging pull requests

Due to Flogger's nature as a subset of Google's internal codebase which is automatically synced to GitHub, we are unable to merge pull requests directly into the master branch. Instead, once a pull request is ready for merging, we'll make the appropriate changes in the internal codebase and sync that internal change out using our regular process. The synced commit will reflect the pull request author as the author of the commit.