Skip to content

Latest commit

 

History

History
225 lines (147 loc) · 11.2 KB

CONTRIBUTING.adoc

File metadata and controls

225 lines (147 loc) · 11.2 KB
Raw

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 Security 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!

Code of Conduct

Please see our code of conduct.

Similar but different

Each Spring module is slightly different from one another in terms of team size, number of issues, etc. Therefore, each project is managed slightly different. You will notice that this document is very similar to the Spring Framework Contributor guidelines. However, there are some subtle differences between the two documents, so please be sure to read this document thoroughly.

Importing into IDE

The following provides information on setting up a development environment that can run the sample in Spring Tool Suite 3.6.0+. Other IDE’s should work using Gradle’s IDE support, but have not been tested.

  • IDE Setup

    • Install Spring Tool Suite 3.6.0+

    • You will need the following plugins installed (can be found on the Extensions Page)

      • Gradle Eclipse

      • Groovy Eclipse

  • Importing the project into Spring Tool Suite

    • File → Import… → Gradle Project

As of new versions of Spring Tool Suite, you might need to install Groovy Eclipse pointing directly to the updated plugin location. To install Groovy Eclipse on Spring Tool Suite based on Eclipse Oxigen you must do the following steps:

Help → Install New Software… → Add the following URL into Work with field: https://dist.springsource.org/snapshot/GRECLIPSE/e4.7/

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; create an issue if necessary

Is there already an issue that addresses your concern? Do a bit of searching in our GitHub issues to see if you can find something similar. If not, please create a new issue before submitting a pull request unless the change is not a user facing issue.

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 Spring Security Gitter before submitting a pull request. We’re happy to provide guidance but please spend an hour or two researching the subject on your own including searching the forums for prior discussions.

Sign the Contributor License Agreement

If you have not previously done so, please fill out and submit the Contributor License Agreement.

Create your branch from main

Create your topic branch to be submitted as a pull request from main. The Spring team will consider your pull request for backporting 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 preferably be named according to GitHub issues, e.g. gh-1234 or gh-1234-fix-npe. Otherwise, use succinct, lower-case, dash (-) delimited names, such as fix-warnings or fix-typo. 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.

Keep commits focused

Remember each ticket should be focused on a single item of interest since the tickets are used to produce the changelog. Since each commit should be tied to a single GitHub issue, ensure that your commits are focused. For example, do not include an update to a transitive library in your commit unless the GitHub is to update the library. Reviewing your commits is essential before sending a pull request.

Mind the whitespace

Please carefully follow the whitespace and formatting conventions already present in the framework.

  1. Tabs, not spaces

  2. Unix (LF), not dos (CRLF) line endings

  3. Eliminate all trailing whitespace

  4. Aim to wrap code at 120 characters, but favor readability over wrapping

  5. Preserve existing formatting; i.e. do not reformat code for its own sake

  6. Search the codebase using git grep and other tools to discover common naming conventions, etc.

  7. UTF-8 encoding for Java sources and XML files

Whitespace management tips

  1. You can use the AnyEdit Eclipse plugin to ensure spaces are used and to clean up trailing whitespaces.

  2. Use Git’s pre-commit.sample hook to prevent invalid whitespace from being pushed out. You can enable it by moving .git/hooks/pre-commit.sample to .git/hooks/pre-commit and ensuring it is executable. For more information on hooks refer to https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks.

Add Apache license header to all new classes

/*
 * Copyright 2002-2020 the original author or 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
 *
 *      https://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.
 */

package ...;

Update Apache 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 2020 whose header still reads

 * Copyright 2002-2012 the original author or authors.

then be sure to update it to the current year appropriately (e.g. 2020)

 * Copyright 2002-2020 the original author or authors.

Use @since tags for newly-added public API types and methods

Example:

/**
 * …
 *
 * @author First Last
 * @since 5.4
 * @see …
 */

Submit JUnit test cases for all behavior changes

Search the codebase to find related unit tests and add additional @Test methods within.

  1. Any new tests should end in the name Tests (note this is plural). For example, a valid name would be FilterChainProxyTests. An invalid name would be FilterChainProxyTest.

  2. New test methods should not start with test. This is an old JUnit3 convention and is not necessary since the method is annotated with @Test.

Update spring-security-x.y.rnc for schema changes

Update the RELAX NG schema spring-security-x.y.rnc instead of spring-security-x.y.xsd if you contribute changes to supported XML configuration. The XML schema file can be generated the following Gradle task:

Changes to the XML schema will be overwritten by the Gradle build task.

Squash commits

Use 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.

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. Make sure the name is properly capitalized as submitted to the Pivotal Contributor License Agreement:

First Last <user@mail.com>

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:

git config --global user.name "First Last"
git config --global user.email user@example.com

or locally for the current repository by omitting the --global flag:

git config user.name "First Last"
git config user.email user@example.com

Format commit messages

  1. Keep the subject line to 50 characters or less if possible

  2. Do not end the subject line with a period

  3. In the body of the commit message, explain how things worked before this commit, what has changed, and how things work now

  4. Include Closes gh-<issue-number> at the end if this fixes a GitHub issue

  5. Avoid markdown, including back-ticks identifying code

Example:

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

Closes gh-123

Run all tests prior to submission

./gradlew clean build integrationTest

Submit your pull request

Subject line:

Follow the same conventions for pull request subject lines as mentioned above for commit message subject lines.

In the body:

  1. 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

  2. Add any additional information and ask questions; start a conversation, or continue one from GitHub Issues

  3. Mention any GitHub Issues

  4. 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 GitHub issue

Add a comment to the associated GitHub 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 Spring Framework 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.