Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove notes about Gerrit and CLA #368

Merged
merged 2 commits into from
Oct 27, 2024
Merged

Remove notes about Gerrit and CLA #368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee6af15
Remove notes about Gerrit and CLA
zbynek Sep 15, 2024
718b849
Mention other repositories, code review section
zbynek Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 16 additions & 39 deletions src/main/markdown/makinggwtbetter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,6 @@ great patches from the community. Before you fire up your favorite IDE
and begin hammering away at that new feature, though, please take the
time to read this section and understand the process. While it seems
rigorous, we want to keep a high standard of quality in the code base.
Also, please be aware that we code contributors must sign a <a
href="#committers">Contributor License Agreement</a> before we can
accept any code.

### Code Style<a id="codestyle"></a>

Expand Down Expand Up @@ -510,55 +507,35 @@ Note that there is a problem using JUnit tests with ant &mdash; a [workaround](#

### Submitting Patches<a id="submittingpatches"></a>

Please do submit code. Here's what you need to do:
Please do submit code. Contributions to all [GWT subprojects](https://github.com/orgs/gwtproject/repositories) are welcome.Here's what you need to do:

1. Decide which code you want to submit. A submission should be a set of changes that addresses one issue in the [GWT issue tracker](https://github.com/gwtproject/gwt/issues?q=is%3Aissue). Please don't mix more than one logical change per submittal, because it makes the history hard to follow. If you want to make a change that doesn't have a corresponding issue in the issue tracker, please create one.
1. Decide which code you want to submit. A submission should be a set of changes that addresses one issue in the repository's issue tracker. For the [GWT SDK](https://github.com/gwtproject/gwt/) you can check the list of [its open issues](https://github.com/gwtproject/gwt/issues). Please don't mix more than one logical change per submittal, because it makes the history hard to follow. If you want to make a change that doesn't have a corresponding issue in the issue tracker, please create one.
2. Also, coordinate with team members that are listed on the issue in question. This ensures that work isn't being duplicated and communicating your plan early also generally leads to better patches.
3. Ensure that your code adheres to the [GWT source code style](#codestyle).
4. Ensure that there are unit tests for your code.
5. Sign in to [GWT's Gerrit service](https://gwt-review.googlesource.com) and sign the [Contributor License Agreement](https://gwt-review.googlesource.com/#/settings/agreements).
6. Push your changes to Gerrit for review. The first time you will need to do some [initial setup](#gerritsetup). Follow Gerrit's documentation to create a change and upload it for review.
7. After setting up gerrit on your system, you can push your changes for review using:
`git push origin HEAD:refs/for/master`

### Gerrit setup<a id="gerritsetup"></a>

Finally, to actually create an issue is slightly more involved, but most of the steps only need to be done once:

1. Setup your HTTP Password:
Go to Settings in Gerrit. Under Settings you will find "HTTP Password" and click "Obtain Password"
and follow the steps to get your HTTP Password and/or to setup your .netrc file.
2. Setup your Gerrit commit-msg hook (optional, but recommended):
Gerrit provides a commit hook at `https://gwt-review.googlesource.com/tools/hooks/commit-msg`
to automatically add Change-Id lines to your commits.
Download this and add it to your checkout's .git/hooks directory:
`curl -o .git/hooks/commit-msg https://gwt-review.googlesource.com/tools/hooks/commit-msg && chmod +x .git/hooks/commit-msg`
3. Make a change and commit it locally using git (e.g., edit a file foo and then run `git commit -m "my first change" foofile`).
Push the commit to Gerrit for review: `git push origin HEAD:refs/for/master`.

If you have any problems you might want to consult the gerrit documentation on [Uploading Changes](https://gerrit-review.googlesource.com/Documentation/user-upload.html)
3. Make a fork of the appropriate repository.
4. Implement your changes, make sure that your code adheres to the [GWT source code style](#codestyle).
5. Ensure that there are unit tests for your code.
6. Push your changes to the forked repository.
7. Create a pull request, follow the suggestions in the pull request template.

### GWT Committers<a id="committers"></a>

The current members of the GWT engineering team are the only committers at present. In the great tradition of eating one's own dogfood, we will be requiring each new GWT engineering team member to earn the right to become a committer by following the procedures in this document, writing consistently great code, and demonstrating repeatedly that he or she truly gets the zen of GWT.
### Code Review

### Contributor License Agreements<a id="clas"></a>
Code review is an essential part of the development process.
Anyone is welcome to submit a code review for any [open pull request](https://github.com/search?q=org%3Agwtproject+is%3Apr+is%3Aopen&type=pullrequests).
Together with the final review done by GWT maintainers,
code reviews by the community have a positive impact on the code quality.

Before we can accept a patch from you, you must sign a Contributor License Agreement (CLA). The CLA protects you and us.

* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
* If you work for a company that wants to allow you to contribute your work to GWT, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
### GWT Committers<a id="committers"></a>

You can sign either CLA through [GWT's Gerrit service](https://gwt-review.googlesource.com/#/settings/agreements).
The current members of the GWT engineering team are the only committers at present. In the great tradition of eating one's own dogfood, we will be requiring each new GWT engineering team member to earn the right to become a committer by following the procedures in this document, writing consistently great code, and demonstrating repeatedly that he or she truly gets the zen of GWT.

### Contributing to webpage and Documentation<a id="webpage"></a>

This webpage and the documentation hosted on it are completely written in markdown. If you find an error, want to make an improvement, write an article or do something to the webpage feel free to do so.

Here is how it works:

All the code is stored on github and can be directly edited on the web by pressing the
"Edit me on Github" button. This is the easiest way to make a change, but if you are
All the code is stored on GitHub and can be directly edited on the web by pressing the
"Edit me on GitHub" button. This is the easiest way to make a change, but if you are
planing to make bigger changes to the website and want to test these locally first,
you can clone the repository:

Expand Down