Contribution guide

First, thank you for contributing! We love and encourage pull requests from everyone. Please follow the guidelines:

  • Find out which repository contains the code you intend to modify.
  • Check open issues and pull requests in that repository for existing discussions.
  • Open an issue first, to discuss a new feature or enhancement.
  • Write tests, and make sure the test suite passes locally and in CI.
  • Open a pull request, and reference the relevant issue(s).
  • Make sure your commits are logically separated and have good comments explaining the details of your change.
  • After receiving feedback, amend your commits or add new ones as appropriate.
  • Have fun!

Git Workflow

FrostFS repositories use trunk-based Git workflow:

  • Development happens in short-lived branches in personal forks of the main repo.
  • Changes are then submitted as a pull request to the master branch of the main repo.
  • Changes are merged to the master branch after passing code review and CI checks.
    • Prefered merge strategy is “rebase-and-fastforward” which results in a nice linear Git history.
    • Squashing multiple commits in a single pull request is not required and may even be frowned upon if it obstructs change review.

We encourage submitting work-in-progress pull requests to discuss code changes.

Developer’s Certificate of Origin

All FrostFS developers retain copyright to their work. However, to ensure that they are only submitting work that they have rights to, we are requiring everyone to acknowledge this by signing their work.

Any copyright notices in FrostFS repositories should specify the authors as “the contributors”.

To sign your work, just add a line like this at the end of your commit message:

Signed-off-by: Samii Sakisaka <samii@ivunojikan.co.jp>

This can easily be done with the --signoff option to git commit.

By doing this you state that you can certify the following (from The Developer Certificate of Origin):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Updated on 18 Feb 2025