Have something you'd like to contribute to the framework? We welcome pull requests, but ask that you carefully read this document first to understand how best to submit them; what kind of changes are likely to be accepted; and what to expect from the Spring team when evaluating your submission.
Please refer back to this document as a checklist before issuing any pull request; this will save time for everyone!
Understand the basics
Not sure what a pull request is, or how to submit one? Take a look at GitHub's excellent help documentation first.
Search GitHub issues first; create an issue if necessary
Is there already an issue that addresses your concern? Do a bit of searching in our issue tracker to see if you can find something similar. If not, please create a new issue before submitting a pull request unless the change is truly trivial, e.g. typo fixes, removing compiler warnings, etc.
Discuss non-trivial contribution ideas with committers
If you're considering anything more than correcting a typo or fixing a minor bug, please discuss it on the s2js-contrib mailing list before submitting a pull request. We're happy to provide guidance but please research the subject on your own including searching the mailing list for prior discussions.
Sign the Contributor License Agreement
If you have not previously done so, please fill out and submit the s2js CLA form. You'll receive a token when this process is complete. Keep track of this; you may be asked for it later!
Note that emailing/postal mailing a signed copy is not necessary. Submission of the web form is all that is required.
Once you've completed the web form, simply add the following in a comment on your pull request:
I have signed and agree to the terms of the s2js Contributor License Agreement.
You do not need to include your token/id. Please add the statement above to all future pull requests as well, simply so that the team knows immediately that this process is complete.
Create your branch from
At any given time, the
master branch represents the latest stable release and
dev branch the version currently under development. For example, if 3.1.1
was the latest release,
master represents 3.1.1 while
dev is 3.2.0
development. There may also be a
3.1.x branch representing 3.1.2 development.
Create your topic branch to be submitted as a pull request from
team will consider your pull request for backporting to maintenance versions
(e.g. 3.1.2) on a case-by-case basis; you don't need to worry about submitting
anything for backporting.
Use short branch names
Branches used when submitting pull requests should use succinct, lower-case, dash (-) delimited names, such as 'fix-warnings', 'fix-typo', etc. In fork-and-edit cases, the GitHub default 'patch-1' is fine as well. This is important, because branch names show up in the merge commits that result from accepting pull requests, and should be as expressive and concise as possible.
Mind the whitespace
Please carefully follow the whitespace and formatting conventions already present in the framework.
- Tabs, not spaces
- Unix (LF), not dos (CRLF) line endings
- Eliminate all trailing whitespace
- Wrap JSDoc at 80 characters
- Aim to wrap code at 80 characters, but favor readability over wrapping
- Preserve existing formatting; i.e. do not reformat code for its own sake
- Search the codebase using
git grepand other tools to discover common naming conventions, etc.
- ascii encoding for JS sources, escape special characters
Add MIT license header to all new source files
/* * Copyright (c) 2013 VMware, Inc. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to * deal in the Software without restriction, including without limitation the * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or * sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS * IN THE SOFTWARE. */
Update license header to modified files as necessary
Always check the date range in the license header. For example, if you've modified a file in 2013 whose header still reads
* Copyright (c) 2012 VMware, Inc.
then be sure to update it to 2013 appropriately
* Copyright (c) 2012-2013 VMware, Inc.
Use @since tags for newly-added public API types and methods
/** * ... * * @author First Last * @since 3.2 * @see ... */
Submit unit test cases for all behavior changes
Search the codebase to find related unit tests and add additional test methods. Create new test cases for new modules.
git rebase --interactive,
git add --patch and other tools to "squash"
multiple commits into atomic changes. In addition to the man pages for git,
there are many resources online to help you understand how these tools work.
Here is one: http://book.git-scm.com/4_interactive_rebasing.html.
Use real name in git commits
Please configure git to use your real first and last name for any commits you intend to submit as pull requests. For example, this is not acceptable:
Author: Nickname <email@example.com>
Rather, please include your first and last name, properly capitalized, as submitted against the SpringSource contributor license agreement:
Author: First Last <firstname.lastname@example.org>
This helps ensure traceability against the CLA, and also goes a long way to
ensuring useful output from tools like
git shortlog and others.
You can configure this globally via the account admin area GitHub (useful for fork-and-edit cases); globally with
git config --global user.name "First Last" git config --global user.email email@example.com
or for the local repository only by omitting the '--global' flag:
git config user.name "First Last" git config user.email firstname.lastname@example.org
Format commit messages
Please read and follow the commit guidelines section of Pro Git.
Most importantly, please format your commit messages in the following way (adapted from the commit template in the link above):
Short (50 chars or less) summary of changes More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together. Further paragraphs come after blank lines. - Bullet points are okay, too - Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here Issue: #9
- Use imperative statements in the subject line, e.g. "Fix broken JSDoc link"
- Begin the subject line sentence with a capitalized verb, e.g. "Add, Prune, Fix, Introduce, Avoid, etc"
- Do not end the subject line with a period
- Keep the subject line to 50 characters or less if possible
- Wrap lines in the body at 72 characters or less
- Mention associated issue(s) at the end of the commit comment, prefixed with "Issue: " as above
- In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now
For examples of this style, issue a
git log --author=cbeams in the
spring-framework git repository. For convenience, here are several such commits:
https://github.com/SpringSource/spring-framework/commit/08e2669b84ec0faa2f7904441fe39ac70b65b078 https://github.com/SpringSource/spring-framework/commit/1d9d3e6ff79ce9f0eca03b02cd1df705925575da https://github.com/SpringSource/spring-framework/commit/8e0b1c3a5f957af3049cfa0438317177e16d6de6 https://github.com/SpringSource/spring-framework/commit/b787a68f2050df179f7036b209aa741230a02477
Run all tests prior to submission
See the building from source section of the README for instructions. Make sure that all tests pass prior to submitting your pull request.
Submit your pull request
Follow the same conventions for pull request subject lines as mentioned above for commit message subject lines.
In the body:
- Explain your use case. What led you to submit this change? Why were existing mechanisms in the framework insufficient? Make a case that this is a general-purpose problem and that yours is a general-purpose solution, etc.
- Add any additional information and ask questions; start a conversation, or continue one from an existing issue
- Mention the issue ID
- Also mention that you have submitted the CLA as described above
Note that for pull requests containing a single commit, GitHub will default the subject line and body of the pull request to match the subject line and body of the commit message. This is fine, but please also include the items above in the body of the request.
Mention your pull request on the associated issue
Add a comment to the associated issue(s) linking to your new pull request.
Expect discussion and rework
The Spring team takes a very conservative approach to accepting contributions to the framework. This is to keep code quality and stability as high as possible, and to keep complexity at a minimum. Your changes, if accepted, may be heavily modified prior to merging. You will retain "Author:" attribution for your Git commits granted that the bulk of your changes remain intact. You may be asked to rework the submission for style (as explained above) and/or substance. Again, we strongly recommend discussing any serious submissions with the team prior to engaging in serious development work.
Note that you can always force push (
git push -f) reworked / rebased commits
against the branch used to submit your pull request. i.e. you do not need to
issue a new pull request when asked to make changes.