Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 5.74 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 5.74 KB
Raw

Contributing to Akka Persistence Postgres

General Workflow

This is the process for committing code into master.

  1. Before starting to work on a feature or a fix, make sure that there is a ticket for your work in the issue tracker. If not, create it first.
  2. Perform your work according to the pull request requirements.
  3. When the feature or fix is completed you should open a Pull Request on GitHub.
  4. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Outside contributors are encouraged to participate in the review process, it is not a closed process.
  5. After the review you should fix the issues (review comments, CI failures) by pushing a new commit for new review, iterating until the reviewers give their thumbs up and CI tests pass.
  6. If the branch merge conflicts with its target, rebase your branch onto the target branch.

Pull Request Requirements

For a Pull Request to be considered at all it has to meet these requirements:

  1. Pull Request branch should be given a unique descriptive name that explains its intent.
  2. Code in the branch should live up to the current code standard:
  3. Regardless if the code introduces new features or fixes bugs or regressions, it must have comprehensive tests.
  4. The code must be well documented (see the Documentation section below).
  5. The commit messages must properly describe the changes, see further below.
  6. Do not use @author tags since it does not encourage Collective Code Ownership. Contributors get the credit they deserve in the release notes.

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.

Documentation

Documentation should be written in two forms:

  1. API documentation in the form of scaladoc/javadoc comments on the Scala and Java user API.
  2. Guide documentation in docs subproject. This documentation should give a short introduction of how a given connector should be used.

External Dependencies

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:

  1. Whenever a committer to the project changes a version of a dependency (including Scala) in the build file.
  2. Whenever a committer to the project adds a new dependency.
  3. Whenever a new release is cut (public or private for a customer).

Which licenses 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.

Creating Commits And Writing Commit Messages

Follow these guidelines when creating public commits and writing commit messages.

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

  2. First line should be a descriptive sentence what the commit is doing, including the ticket number. It should be possible to fully understand what the commit does—but not necessarily how it does it—by just reading this single line. We follow the “imperative present tense” style for commit messages (more info here).

    It is not ok to only list the ticket number, type "minor fix" or similar. If the commit is a small fix, then you are done. If not, go to 3.

  3. Following the single line description should be a blank line followed by an enumerated list with the details of the commit.

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

Example:

Add eventsByTag query #123

* Details 1
* Details 2
* Details 3

How To Enforce These Guidelines?

  1. GitHub Actions automatically builds the code, runs the tests and sets Pull Request status accordingly of results in GitHub.
  2. Scalafmt enforces some of the code style rules.