Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 2.55 KB
Raw

How to Contribute

Loodse projects are Apache 2.0 licensed and accept contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

Any copyright notices in this repo should specify the authors as "the Loodse XXX project contributors".

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

Signed-off-by: Joe Example <joe@example.com>

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

Note that we're requiring all commits in a PR to be signed-off. If you already created a PR, you can sign-off all existing commits by rebasing with the --signoff flag.

git rebase --signoff origin/master

By doing this you state that you can certify the following (from https://developercertificate.org/):

Email and Chat

The XXX project currently uses the general Loodse email list and Slack channel:

Please avoid emailing maintainers found in the MAINTAINERS file directly. They are very busy and read the mailing lists.

Reporting a security vulnerability

Due to their public nature, GitHub and mailing lists are not appropriate places for reporting vulnerabilities. If you suspect you have found a security vulnerability, please do not file a GitHub issue, but instead email security@loodse.com with the full details, including steps to reproduce the issue.

Getting Started

  • Fork the repository on GitHub
  • Read the README for build and test instructions
  • Play with the project, submit bugs, submit patches!

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a topic branch from where you want to base your work (usually master).
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Make sure the tests pass, and add any new tests as appropriate.
  • Submit a pull request to the original repository.

Thanks for your contributions!