Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 3.42 KB
Raw

Guidelines for contributing to Protostream

Contributions from the community are essential in keeping Protostream strong and successful.

This guide focuses on how to contribute back to Protostream using GitHub pull requests. If you need help with cloning, compiling or setting the project up in an IDE please refer to our Contributing Guide.

Legal

All original contributions to Protostream are licensed under the ASL - Apache License, version 2.0 or later, or, if another license is specified as governing the file or directory being modified, such other license.

All contributions are subject to the Developer Certificate of Origin (DCO). The DCO text is also included verbatim in the dco.txt file in the root directory of the repository.

Getting Started

If you are just getting started with Git, GitHub and/or contributing to Protostream there are a few prerequisite steps:

  • Make sure you have a GitHub account
  • Fork the Protostream repository. As discussed in the linked page, this also includes:
    • Setting up your local git install
    • Cloning your fork

Create a test case

If you have opened an issue but are not comfortable enough to contribute code directly, creating a self-contained test case is a good first step towards contributing.

Just fork the repository, build your test case and attach it as an archive to a JIRA issue.

Create a topic branch

Create a "topic" branch on which you will work. The convention is to name the branch using the issue key. If there is not already an issue covering the work you want to do, create one. Assuming you will be working from the main branch and working on issue #123

git checkout -b 123 main

Code

Code away...

Formatting rules and style conventions

The Infinispan family projects share the same style conventions. Please refer to our Contributing Guide for more details.

Commit

  • Make commits of logical units.
  • Be sure to start the commit messages with the issue key you are working on.
  • Avoid formatting changes to existing code as much as possible: they make the intent of your patch less clear.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken:
mvn verify

Prior to committing, if you want to pull in the latest upstream changes (highly appreciated by the way), please use rebasing rather than merging (see instructions below). Merging creates "merge commits" that really muck up the project timeline.

Add the original Protostream repository as a remote repository called upstream:

git remote add upstream [email protected]:infinispan/protostream.git

If you want to rebase your branch on top of the main branch, you can use the following git command:

git pull --rebase upstream main

Submit

  • Push your changes to a topic branch in your fork of the repository.
  • Initiate a pull request.
  • Reference the issue in the pull request description so that the two are cross-linked.