Typesafe Project & Developer Guidelines
These guidelines are meant to be a living document that should be changed and adapted as needed. We encourage changes that makes it easier to achieve our goals in an efficient way.
These guidelines mainly applies to Typesafe’s “mature” projects - not necessarily to projects of the type ‘collection of scripts’ etc.
This is the process for committing code into master. There are of course exceptions to these rules, for example minor changes to comments and documentation, fixing a broken build etc.
- Make sure you have signed the Typesafe CLA, if not, sign it online.
- Before starting to work on a feature or a fix, you have to make sure that:
- There is a ticket for your work in the project's issue tracker. If not, create it first.
- The ticket has been scheduled for the current milestone.
- The ticket is estimated by the team.
- The ticket have been discussed and prioritized by the team.
- You should always perform your work in a Git feature branch. The branch should be given a descriptive name that explains its intent. Some teams also like adding the ticket number and/or the GitHub user ID to the branch name, these details is up to each of the individual teams.
- When the feature or fix is completed you should open a Pull Request on GitHub.
- The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Note that the maintainers can consist of outside contributors, both within and outside Typesafe. Outside contributors (for example from EPFL or independent committers) are encouraged to participate in the review process, it is not a closed process.
- After the review you should fix the issues as needed (pushing a new commit for new review etc.), iterating until the reviewers give their thumbs up.
- Once the code has passed review the Pull Request can be merged into the master branch.
Pull Request Requirements
For a Pull Request to be considered at all it has to meet these requirements:
- Live up to the current code standard:
- Regardless if the code introduces new features or fixes bugs or regressions, it must have comprehensive tests.
- The code must be well documented in the Typesafe's standard documentation format (see the ‘Documentation’ section below).
- Copyright: All Typesafe projects must include Typesafe copyright notices. Each project can choose between one of two approaches:
- All source files in the project must have a Typesafe copyright notice in the file header.
- The Notices file for the project includes the Typesafe copyright notice and no other files contain copyright notices. See http://www.apache.org/legal/src-headers.html for instructions for managing this approach for copyrights.
Other guidelines to follow for copyright notices:
- Use a form of
Copyright (C) 2011-2014 Typesafe Inc. <http://www.typesafe.com>, where the start year is when the project or file was first created and the end year is the last time the project or file was modified.
- Never delete or change existing copyright notices, just add additional info.
- Do not use
@author tags since it does not encourage Collective Code Ownership. However, each project should make sure that the contributors gets the credit they deserve—in a text file or page on the project website and in the release notes etc.
If these requirements are not met then the code should not be merged into master, or even reviewed - regardless of how good or important it is. No exceptions.
Each project should be configured to use a continuous integration (CI) tool (i.e. a build server ala Jenkins). Typesafe has a Jenkins server farm that can be used. The CI tool should, on each push to master, build the full distribution and run all tests, and if something fails it should email out a notification with the failure report to the committer and the core team. The CI tool should also be used in conjunction with Typesafe’s Pull Request Validator (discussed below).
All documentation should be generated using the sbt-site-plugin, or publish artifacts to a repository that can be consumed by the typesafe stack.
All documentation must abide by the following maxims:
- Example code should be run as part of an automated test suite.
- Version should be programmatically specifiable to the build.
- Generation should be completely automated and available for scripting.
- Artifacts that must be included in the Typesafe Stack should be published to a maven “documentation” repository as documentation artifacts.
All documentation is preferred to be in Typesafe's standard documentation format reStructuredText compiled using Typesafe's customized Sphinx based documentation generation system, which among other things allows all code in the documentation to be externalized into compiled files and imported into the documentation.
For more info, or for a starting point for new projects, look at the Typesafe Documentation Template project
For larger projects that have invested a lot of time and resources into their current documentation and samples scheme (like for example Play), it is understandable that it will take some time to migrate to this new model. In these cases someone from the project needs to take the responsibility of manual QA and verifier for the documentation and samples.
All the external runtime dependencies for the project, including transitive dependencies, must have an open source license that is equal to, or compatible with, Apache 2.
This must be ensured by manually verifying the license for all the dependencies for the project:
- Whenever a committer to the project changes a version of a dependency (including Scala) in the build file.
- Whenever a committer to the project adds a new dependency.
- Whenever a new release is cut (public or private for a customer).
Which licenses that are compatible with Apache 2 are defined in this doc, where you can see that the licenses that are listed under
Category A automatically compatible with Apache 2, while the ones listed under
Category B needs additional action:
“Each license in this category requires some degree of reciprocity; therefore, additional action must be taken in order to minimize the chance that a user of an Apache product will create a derivative work of a reciprocally-licensed portion of an Apache product without being aware of the applicable requirements.”
Each project must also create and maintain a list of all dependencies and their licenses, including all their transitive dependencies. This can be done in either in the documentation or in the build file next to each dependency.
Work In Progress
It is ok to work on a public feature branch in the GitHub repository. Something that can sometimes be useful for early feedback etc. If so then it is preferable to name the branch accordingly. This can be done by either prefix the name with
wip- as in ‘Work In Progress’, or use hierarchical names like
topic/... Either way is fine as long as it is clear that it is work in progress and not ready for merge. This work can temporarily have a lower standard. However, to be merged into master it will have to go through the regular process outlined above, with Pull Request, review etc..
Also, to facilitate both well-formed commits and working together, the
topic identifiers also have special meaning. Any branch labelled with
wip is considered “git-unstable” and may be rebased and have its history rewritten. Any branch with
topic in the name is considered “stable” enough for others to depend on when a group is working on a feature.
Creating Commits And Writing Commit Messages
Follow these guidelines when creating public commits and writing commit messages.
- If your work spans multiple local commits (for example; if you do safe point commits while working in a feature branch or work in a branch for long time doing merges/rebases etc.) then please do not commit it all but rewrite the history by squashing the commits into a single big commit which you write a good commit message for (like discussed in the following sections). For more info read this article: Git Workflow. Every commit should be able to be used in isolation, cherry picked etc.
- First line should be a descriptive sentence what the commit is doing. It should be possible to fully understand what the commit does by just reading this single line. It is not ok to only list the ticket number, type "minor fix" or similar. Include reference to ticket number, prefixed with #, at the end of the first line. If the commit is a small fix, then you are done. If not, go to 3.
- Following the single line description should be a blank line followed by an enumerated list with the details of the commit.
- Add keywords for your commit (depending on the degree of automation we reach, the list may change over time):
Review by @gituser- if you want to notify someone on the team. The others can, and are encouraged to participate.
Fix/Fixing/Fixes/Close/Closing/Refs #ticket- if you want to mark the ticket as fixed in the issue tracker (Assembla understands this).
backport to _branch name_- if the fix needs to be cherry-picked to another branch (like 2.9.x, 2.10.x, etc)
Adding monadic API to Future. Fixes #2731 * Details 1 * Details 2 * Details 3
How To Enforce These Guidelines?
Make Use Of Typesafe’s Pull Request Validator
It is recommended to set up the project to use Typesafe’s Pull Request Validator that automatically merges the code, builds it, runs the tests and comments on the Pull Request in GitHub.
Add A CONTRIBUTING.md File To GitHub
It is recommended that each project add a
CONTRIBUTING.md file (preferably this document) to their project on GitHub. This makes people get a notice about it when they try to open a Pull Request. Read more about it here.
SIPs (only applies to Scala project)
A SIP (Scala Improvement Process) needs an implementation, including cross-feature testing before we can accept it. There should be a clear distinction between "Approved To Develop" vs. "Accepted For Release X".