The CUE project welcomes all contributors.
This document is a guide to help you through the process of contributing to the CUE project, which is a little different from that used by other open source projects. We assume you have a basic understanding of Git and Go.
The first step is registering as a CUE contributor and configuring your environment. Here is a checklist of the required steps to follow:
GO111MODULE=on go get golang.org/x/review/git-codereview(or just
go install golang.org/x/review/git-codereview@latestif you are using Go 1.16)
Note that if you plan to contribute via GitHub, only Steps 0 and 1 are required.
The rest of this chapter elaborates on these instructions. If you have completed the steps above (either manually or through the tool), jump to "Before contributing code."
A contribution to CUE is made through a specific e-mail address. Make sure to use the same account throughout the process and for all your subsequent contributions. You may need to decide whether to use a personal address or a corporate address. The choice will depend on who will own the copyright for the code that you will be writing and submitting. You might want to discuss this topic with your employer before deciding which account to use.
You also need to make sure that your Git tool is configured to create commits using your chosen e-mail address. You can either configure Git globally (as a default for all projects), or locally (for a single specific project). You can check the current configuration with this command:
$ git config --global user.email # check current global config $ git config user.email # check current local config
To change the configured address:
$ git config --global user.email firstname.lastname@example.org # change global config $ git config user.email email@example.com # change local config
If the copyright holder for the code you are submitting changes—for example, if you start contributing code on behalf of a new company—please send mail to the CUE Owners. This will let us know the situation so we can make sure an appropriate agreement is completed and update the
Contributions to the CUE project must be accompanied by a Developer Certificate of Origin, the text of which is reproduced here for convenience:
Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
All commit messages must contain the
Signed-off-by line with an email address that matches the commit author. When commiting, use the
git commit -s
If you have not used GerritHub before, setting up an account is a simple process:
If you want to use SSH for authentication, SSH keys can be configured in your user profile.
For HTTP Credentials, generate a password via your user profile. Then use an existing HTTP authentication mechanism like
.netrc, macOS KeyChain, or some other crendential helper. If you have any troubles with this step, please raise an issue.
Then visit https://review.gerrithub.io/admin/repos/cue-lang/cue, then click "HTTP" or "SSH" then copy the corresponding "Clone" command.
Changes to CUE must be reviewed before they are accepted, no matter who makes the change. A custom
git command called
git-codereview simplifies sending changes to Gerrit.
git-codereview command by running,
$ GO111MODULE=on go get golang.org/x/review/git-codereview
or with Go 1.16:
$ go install golang.org/x/review/git-codereview@latest
git-codereview is installed in your shell path, so that the
git command can find it. Check that
$ git codereview help
prints help text, not an error.
On Windows, when using git-bash you must make sure that
git-codereview.exe is in your
git exec-path. Run
git --exec-path to discover the right location then create a symbolic link or just copy the executable from $GOPATH/bin to this directory.
Whether you already know what contribution to make, or you are searching for an idea, the issue tracker is always the first place to go. Issues are triaged to categorize them and manage the workflow.
Most issues will be marked with one of the following workflow labels:
You can use GitHub's search functionality to find issues to help out with. Examples:
is:issue is:open label:NeedsInvestigation
is:issue is:open label:NeedsFix
is:issue is:open label:NeedsFix "cuelang.org/cl"
is:issue is:open label:NeedsFix NOT "cuelang.org/cl"
Excluding very trivial changes, all contributions should be connected to an existing issue. Feel free to open one and discuss your plans. This process gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits inside the goals for the language and tools. It also checks that the design is sound before code is written; the code review tool is not the place for high-level discussions.
It is not possible to fully sync Gerrit and GitHub, although things are improving, so we recommend learning Gerrit. It's different but powerful and familiarity with help you understand the flow.
This is an overview of the overall process:
Then make sure it's stable by compiling and testing it once:
$ cd cue $ go test ./... $ go install ./cmd/cue
change; that will create or amend a single commit in the branch.
$ git checkout -b mybranch $ [edit files...] $ git add [files...] $ git codereview change -s # create commit in the branch $ [edit again...] $ git add [files...] $ git codereview change -s # amend the existing commit with new changes $ [etc.]
$ go test ./... # recompile and test
$ git codereview mail # send changes to Gerrit
$ [edit files...] $ git add [files...] $ git codereview change -s # update same commit $ git codereview mail # send to Gerrit again
The rest of this section describes these steps in more detail.
In addition to a recent CUE installation, you need to have a local copy of the source checked out from the correct repository. You can check out the CUE source repo onto your local file system anywhere you want as long as it's outside your
Visit https://review.gerrithub.io/admin/repos/cue-lang/cue, then click "SSH" or "HTTP" dependending on which authentication mechanism you configured above. Then copy and run the corresponding "Clone" command.
Then make sure it's stable by compiling and testing it once:
$ cd cue $ go test ./... # go install ./cmd/cue
Each CUE change must be made in a separate branch, created from the master branch. You can use the normal
git commands to create a branch and add changes to the staging area:
$ git checkout -b mybranch $ [edit files...] $ git add [files...]
To commit changes, instead of
git commit -s, use
git codereview change -s.
$ git codereview change -s (open $EDITOR)
You can edit the commit description in your favorite editor as usual. The
change command will automatically add a unique Change-Id line near the bottom. That line is used by Gerrit to match successive uploads of the same change. Do not edit or delete it. A Change-Id looks like this:
The tool also checks that you've run
fmt over the source code, and that the commit message follows the suggested format.
If you need to edit the files again, you can stage the new changes and re-run
change: each subsequent run will amend the existing commit while preserving the Change-Id.
Make sure that you always keep a single commit in each branch. If you add more commits by mistake, you can use
rebase to squash them together into a single one.
You've written and tested your code, but before sending code out for review, run all the tests for the whole tree to make sure the changes don't break other packages or programs:
$ go test ./...
Once the change is ready and tested over the whole tree, send it for review. This is done with the
$ git codereview mail
Gerrit assigns your change a number and URL, which
remote: New Changes: remote: https://review.gerrithub.io/99999 math: improved Sin, Cos and Tan precision for very large arguments
If you get an error instead, check the Troubleshooting mail errors section.
If your change relates to an open GitHub issue and you have followed the suggested commit message format, the issue will be updated in a few minutes by a bot, linking your Gerrit change to it in the comments.
CUE maintainers will review your code on Gerrit, and you will get notifications via e-mail. You can see the review on Gerrit and comment on them there. You can also reply using e-mail if you prefer.
If you need to revise your change after the review, edit the files in the same branch you previously created, add them to the Git staging area, and then amend the commit with
$ git codereview change -s # amend current commit (open $EDITOR) $ git codereview mail # send new changes to Gerrit
If you don't need to change the commit description, just save and exit from the editor. Remember not to touch the special Change-Id line.
Again, make sure that you always keep a single commit in each branch. If you add more commits by mistake, you can use
git rebase to squash them together into a single one.
Commit messages in CUE follow a specific set of conventions, which we discuss in this section.
Here is an example of a good one:
math: improve Sin, Cos and Tan precision for very large arguments The existing implementation has poor numerical properties for large arguments, so use the McGillicutty algorithm to improve accuracy above 1e10. The algorithm is described at https://wikipedia.org/wiki/McGillicutty_Algorithm Fixes #159
The first line of the change description is conventionally a short one-line summary of the change, prefixed by the primary affected package.
A rule of thumb is that it should be written so to complete the sentence "This change modifies CUE to _____." That means it does not start with a capital letter, is not a complete sentence, and actually summarizes the result of the change.
Follow the first line by a blank line.
The rest of the description elaborates and should provide context for the change and explain what it does. Write in complete sentences with correct punctuation, just like for your comments in CUE. Don't use HTML, Markdown, or any other markup language.
The special notation "Fixes #12345" associates the change with issue 12345 in the CUE issue tracker When this change is eventually applied, the issue tracker will automatically mark the issue as fixed.
If the change is a partial step towards the resolution of the issue, uses the notation "Updates #12345". This will leave a comment in the issue linking back to the change in Gerrit, but it will not close the issue when the change is applied.
If you are sending a change against a subrepository, you must use the fully-qualified syntax supported by GitHub to make sure the change is linked to the issue in the main repository, not the subrepository. All issues are tracked in the main repository's issue tracker. The correct form is "Fixes #159".
This section explains the review process in detail and how to approach reviews after a change has been mailed.
When a change is sent to Gerrit, it is usually triaged within a few days. A maintainer will have a look and provide some initial review that for first-time contributors usually focuses on basic cosmetics and common mistakes. These include things like:
The CUE community values very thorough reviews. Think of each review comment like a ticket: you are expected to somehow "close" it by acting on it, either by implementing the suggestion or convincing the reviewer otherwise.
After you update the change, go through the review comments and make sure to reply to every one. You can click the "Done" button to reply indicating that you've implemented the reviewer's suggestion; otherwise, click on "Reply" and explain why you have not, or what you have done instead.
It is perfectly normal for changes to go through several round of reviews, with one or more reviewers making new comments every time and then waiting for an updated change before reviewing again. This cycle happens even for experienced contributors, so don't be discouraged by it.
As they near a decision, reviewers will make a "vote" on your change. The Gerrit voting system involves an integer in the range -2 to +2:
After the code has been +2'ed, an approver will apply it to the master branch using the Gerrit user interface. This is called "submitting the change".
The two steps (approving and submitting) are separate because in some cases maintainers may want to approve it but not to submit it right away (for instance, the tree could be temporarily frozen).
Submitting a change checks it into the repository. The change description will include a link to the code review, which will be updated with a link to the change in the repository. Since the method used to integrate the changes is Git's "Cherry Pick", the commit hashes in the repository will be changed by the submit operation.
If your change has been approved for a few days without being submitted, feel free to write a comment in Gerrit requesting submission.
This section collects a number of other comments that are outside the issue/edit/code review/submit process itself.
Files in the CUE repository don't list author names, both to avoid clutter and to avoid having to keep the lists up to date. Instead, your name will appear in the change log and in the
CONTRIBUTORS file and perhaps the
AUTHORS file. These files are automatically generated from the commit logs periodically. The
AUTHORS file defines who “The CUE Authors”—the copyright holders—are.
New files that you contribute should use the standard copyright header:
// Copyright 2018 The CUE Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License.
(Use the current year if you're reading this in 2019 or beyond.) Files in the repository are copyrighted the year they are added. Do not update the copyright year on files that you change.
The most common way that the
If you see something like...
remote: Processing changes: refs: 1, done remote: remote: ERROR: In commit ab13517fa29487dcf8b0d48916c51639426c5ee9 remote: ERROR: author email address XXXXXXXXXXXXXXXXXXX remote: ERROR: does not match your user account.
you need to configure Git for this repository to use the e-mail address that you registered with. To change the e-mail address to ensure this doesn't happen again, run:
$ git config user.email firstname.lastname@example.org
Then change the commit to use this alternative e-mail address with this command:
$ git commit --amend --author="Author Name <email@example.com>"
Then retry by running:
$ git codereview mail
go test ./... for every single change to the code tree is burdensome. Even though it is strongly suggested to run it before sending a change, during the normal development cycle you may want to compile and test only the package you are developing.
In this section, we'll call the directory into which you cloned the CUE repository
$CUEDIR. As CUE uses Go modules, The
cue tool built by
go install will be installed in the
bin/go in your home directory by default.
If you're changing the CUE APIs or code, you can test the results in just this package directory.
$ cd $CUEDIR/cue $ [make changes...] $ go test
You don't need to build a new cue tool to test it. Instead you can run the tests from the root.
$ cd $CUEDIR $ go test ./...
To use the new tool you would still need to build and install it.
You can specify a reviewer or CC interested parties using the
-cc options. Both accept a comma-separated list of e-mail addresses:
$ git codereview mail -r firstname.lastname@example.org -cc email@example.com,firstname.lastname@example.org
While you were working, others might have submitted changes to the repository. To update your local branch, run
$ git codereview sync
(Under the covers this runs
As part of the review process reviewers can propose changes directly (in the GitHub workflow this would be someone else attaching commits to a pull request).
You can import these changes proposed by someone else into your local Git repository. On the Gerrit review page, click the "Download ▼" link in the upper right corner, copy the "Checkout" command and run it from your local Git repo. It will look something like this:
$ git fetch https://review.gerrithub.io/a/cue-lang/cue refs/changes/67/519567/1 && git checkout FETCH_HEAD
To revert, change back to the branch you were working in.
git-codereview command can be run directly from the shell by typing, for instance,
$ git codereview sync
but it is more convenient to set up aliases for
git-codereview's own subcommands, so that the above becomes,
$ git sync
git-codereview subcommands have been chosen to be distinct from Git's own, so it's safe to define these aliases. To install them, copy this text into your Git configuration file (usually
.gitconfig in your home directory):
[alias] change = codereview change gofmt = codereview gofmt mail = codereview mail pending = codereview pending submit = codereview submit sync = codereview sync
Advanced users may want to stack up related commits in a single branch. Gerrit allows for changes to be dependent on each other, forming such a dependency chain. Each change will need to be approved and submitted separately but the dependency will be visible to reviewers.
To send out a group of dependent changes, keep each change as a different commit under the same branch, and then run:
$ git codereview mail HEAD
Make sure to explicitly specify
HEAD, which is usually not required when sending single changes.
Guidelines for participating in CUE community spaces and a reporting process for handling issues can be found in the Code of Conduct.