-
Notifications
You must be signed in to change notification settings - Fork 185
Update CONTRIBUTING.MD #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,127 @@ | ||
| # How to Contribute | ||
| # How to Contribute to the Google Ads API Client Library for Java | ||
|
|
||
| We'd love to accept your patches and contributions to this project. There are | ||
| just a few small guidelines you need to follow. | ||
| ## Overview: We Welcome Your Contributions | ||
|
|
||
| ## Contributor License Agreement | ||
| Welcome and thank you for your interest in contributing to the Google Ads API Client Library for | ||
| Java. Open source contributions are important to foster a vibrant developer community and help | ||
| us provide a world-class developer experience. We value your contributions, no matter how small. | ||
| Even small documentation fixes can go a long way in helping other developers use our API. Before | ||
| contributing, please review the guidelines and best practices below. | ||
|
|
||
| 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. | ||
| * [Providing Feedback](#providing-feedback) | ||
| * [Feature Requests](#feature-requests) | ||
| * [Bug Reports](#bug-reports) | ||
| * [Contributing](#contributing) | ||
| * [Contributor License Agreement (CLA)](#contributor-license-agreement-cla) | ||
| * [How Libraries are Generated](#how-libraries-are-generated) | ||
| * [Pull Request Submission Best Practices](#pull-request-submission-best-practices) | ||
| * [Style Guidelines & Naming Conventions](#style-guidelines--naming-conventions) | ||
| * [Claiming Requests](#claiming-requests) | ||
| * [Testing](#testing) | ||
| * [Community Guidelines](#community-guidelines) | ||
|
|
||
| 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. | ||
| ## Providing Feedback | ||
|
|
||
| ## Code reviews | ||
| This repository is specifically for the Google Ads API Client Library for Java. If you have feedback | ||
| related to the Google Ads API, please submit it by clicking the **Send feedback** button in the top right | ||
| corner of [this page](https://developers.google.com/google-ads/api/support). | ||
|
|
||
| All submissions, including submissions by project members, require review. We | ||
| use GitHub pull requests for this purpose. Consult | ||
| [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | ||
| information on using pull requests. | ||
| ### Feature Requests | ||
|
|
||
| We appreciate your feedback and encourage you to submit feature requests that | ||
| will help improve this library. | ||
|
|
||
| If you see that someone has already created an issue that describes your proposed feature request, | ||
| please upvote their idea to avoid duplicates and help our team prioritize feature requests. | ||
| Github provides a similar issues search as you create new issues, which can help in this | ||
| effort. In addition, if you have commentary or can build upon someone else’s idea, feel free to | ||
| do so by adding a comment. | ||
|
|
||
| Please submit feature requests related to **this repository** by creating a new issue using | ||
| the [Feature Request](https://github.com/googleads/google-ads-java/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) | ||
| template. | ||
|
|
||
| ### Bug Reports | ||
|
|
||
| We appreciate your feedback and encourage you to report bugs that will help | ||
| improve this library. | ||
|
|
||
| If you see that someone has already created a bug that describes your bug, please upvote their | ||
| issue to avoid duplicates and help our team prioritize feature requests. In addition, if you | ||
| have additional commentary that can help us solve the issue, please add a comment with the | ||
| relevant information. It may be helpful to provide the request and response logs associated | ||
| with your bug. | ||
|
|
||
| Please submit bugs related to **this repository** by creating a new issue using the | ||
| [Bug](https://github.com/googleads/google-ads-java/issues/new?assignees=&labels=bug&template=bug_report.md&title=) | ||
| template. | ||
|
|
||
| **Please do not include any personal identifiable information or authorization/access data | ||
| in any of the information you post.** | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Contributor License Agreement (CLA) | ||
|
|
||
| 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 Libraries are Generated | ||
|
|
||
| This section is intended to provide background regarding how we generate our client libraries so | ||
| that you only submit pull requests that we will be able to use (we don’t want you wasting your | ||
| time). We automatically generate the majority of our client library code from these | ||
| [protocol buffers](https://github.com/googleapis/googleapis/tree/master/google/ads/googleads) | ||
| that define the API. As a result, the names of certain methods and variables may be | ||
| created automatically. Generated code is generally located in folders with the name of a | ||
| version, such as v1 or v2. We will not be able to accept pull requests for open source | ||
| improvements to the codebase related to generated code. Please share any feedback of this | ||
| nature by [creating an issue](#providing-feedback) as we may be able to make fixes | ||
| to the code generation process internally. We also welcome any pull requests related to | ||
| this library not related to generated code. | ||
|
|
||
| ### Pull Request Submission Best Practices | ||
|
|
||
| If your pull request does not address an existing issue, we suggest | ||
| [creating an issue](#providing-feedback) outlining your proposed changes to | ||
| ensure they align with the existing roadmap and are able to be accepted. | ||
| When making a pull request, first make your own forked copy of this repository, make any changes | ||
| on a separate branch of that forked copy, then submit the pull request from your new fork/branch. | ||
| Consult | ||
| [GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) | ||
| for more information on using pull requests. | ||
|
|
||
| All submissions, including submissions by project members, require review. Upon receiving your | ||
| pull request, our team will review the changes and may provide you with feedback, questions, | ||
| or comments in order to maintain a high level of quality throughout this repository. We ask | ||
| that you address feedback in a timely manner so that we can merge your changes into the main branch. | ||
|
|
||
| ### Style Guidelines & Naming Conventions | ||
|
|
||
| Please conform your submitted code to Google’s official | ||
| [style guide for Java](https://google.github.io/styleguide/javaguide.html). | ||
| You can use this [style guide converter](https://github.com/google/google-java-format) to easily | ||
| reformat your code to to comply with Google Style. In addition, please leave comments in your code | ||
| in a manner consistent with other code in this repository. | ||
|
|
||
| ### Claiming Requests | ||
|
|
||
| If you see a feature request or bug in the issues list for which you would like to submit a pull | ||
| request, please let us know by “claiming” the request in the comments, and we can assign the | ||
| issue to you. This will help to avoid duplicate work. | ||
|
|
||
| ### Testing | ||
|
|
||
| If you make any changes to this codebase, ensure that all existing tests continue to pass. | ||
| In addition, add tests that validate your changes to ensure that future changes do not break | ||
| your new feature or bug fix. | ||
|
|
||
| ## Community Guidelines | ||
|
|
||
| This project follows [Google's Open Source Community | ||
| Guidelines](https://opensource.google.com/conduct/). | ||
| This project follows | ||
| [Google's Open Source Community Guidelines](https://opensource.google/conduct/). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.