related workflows and GitHub • Willingness to discuss, elaborate and rework your proposals • Contributor License Agreement (CLA) – cla.pivotal.io • Patience :)
contributing easy • Projects are well managed with contributors in mind – Easy to build & import in IDE • Contributions are properly attributed – Commits, @author tags
Learn new skills, improve existing ones – Apply the ideas from Spring projects to your own projects • Meet the people behind Spring and collaborate with them • Grow your reputation • Contributing is an empowering experience
contain resources for contributors – README, CONTRIBUTING, CODE_OF_CONDUCT • Note the project’s active branches • Check out the issues marked for contribution – JIRA roadmap, GitHub labels
Gradle or Maven • Single-click builds that are easy on the newcomers – ./gradlew build or ./mvnw clean install • Check out resources for contributors for more details – Some projects have special build profiles, for example documentation builds
preferred Git workflows – Merge vs rebase • Note the preferred code style – Check source repository for IDE config files • Use other contributions as a reference • Reach out to the project maintainers or community – Gitter or Stack Overflow
copy with all branches of the original repository – Some of them are not active, or not needed • Deleting needless branches makes your fork easier to maintain
exists, drop a note you’re working on it – To help prevent duplicating efforts • Otherwise new issue might be needed • Pick the appropriate target branch – Semantic versioning matters - semver.org • If in doubt about target branch consult the maintainers
to use appropriate code style – look for Eclipse formatter configuration files – IntelliJ IDEA: Eclipse Code Formatter plugin • Create a dedicated feature branch for your changes - use target branch as base • Initially make your changes a single commit unless there’s a good reason to do otherwise
are a must if you touch the code – JUnit, AssertJ, Mockito, Spring Test support • Bug: add a test that reproduces the issue – Check out the contributors resources • New feature: a substantial set of tests is expected – Check the existing unit tests for similar/related functionalities
excellent resources on writing good commit messages – Check out the contributors resources – chris.beams.io/posts/git-commit • Good commit message does you a favor when opening the PR – Commit message is automatically used for PR description on GitHub
single-click and easy to run – Check contributor resources for info on additional build profiles, like documentation • Contains additional checks, such as Checkstyle – import the IDE code style config – Use Checkstyle plugin for your IDE • Tests the impact of your changes on entire project
to sign CLA – cla.pivotal.io has all the details – The process in nearly automatic these days • Minor changes can skip some checks – CLA not required - add “Obvious Fix” to the PR description – Skip the Travis CI build - include “[ci skip]” in commit message
sometime get stuck or fail for transient reasons – You can trigger the build again by closing and reopening the PR – Or more elegantly using Git $ git commit --amend --no-edit && git push --force
proposals, especially if PR is about new features • Often times you’ll be asked to rework your proposal • Don’t open a PR and walk away – If unsure how to rework your proposal ask for help – If you have no time to rework let the maintainers know
done on the existing PR - no need to close existing and open new one • you can simply push more commits to your PR branch • you can update the existing commit (force push is needed) $ git add . && git commit --amend --no-edit && git push --force
- be patient – It might get some time for maintainers to get to your PR • Your contribution was not accepted - don’t get discouraged – If you’re active in the open source this will happen sooner or later :) • Your contribution was accepted - welcome to the club!
With Spring 5 around the corner there’s a lot of movement across the Spring ecosystem – Move to Java 8 as baseline, introduction of reactive programming model • Most Spring projects are moving to new major release as a consequence – Chance to make significant changes
vpavic
recruitengineers
lycorp_recruit_jp
eijikominami
chou500
rrreeeyyy
emiki
10xinc
sinsoku
onk
chanyou0311
sonatard
kamina_zzz
tammyeverts
addyosmani
maltzj
aarron
kastner
reverentgeek
akosma
rasmusluckow
ddemaree
erikaheidi
jcasabona
