Want to contribute? Great! You can do so through the standard GitHub fork and pull model . A description of the workflow from a technical point of view is described in our Developer Guide.
For large contributions we do encourage you to file a ticket in the GitHub issue tracking system prior to any code development to coordinate with the Carbyne Stack maintainers early in the process. Coordinating up front helps to avoid frustration later on.
Your contribution must be licensed under the Apache-2.0 license, the license
used by this project.
Include a copyright notice and license in each new file to be contributed, consistent with the style used by this project. If your contribution contains code under the copyright of a third party, document its origin, license, and copyright holders. Under no circumstances should you remove existing copyright notices, license texts and headers, or disclaimers.
Carbyne Stack is security-related software, and attacks on the supply chain of security-related software are a real threat. Therefore, we require cryptographically signed commits. This ensures that the author of the contributed code is actually the person whose name is on the commits, and that the code change is actually what the author wrote.
There are a lot of great guides out there that make setting up your environment to support signed commits a breeze (see e.g., the comprehensive blog post How (and why) to sign Git commits from Alessandro Segala). Please also see our Developer Guide for more information on this topic.
This project tracks patch provenance and licensing using the Developer Certificate of Origin 1.1 (DCO) from developercertificate.org and Signed-off-by tags initially developed by the Linux kernel project.
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.
With the sign-off in a commit message you certify that you authored the patch or otherwise have the right to submit it under an open source license. The procedure is simple: To certify above Developer's Certificate of Origin 1.1 for your contribution just append a line
Signed-off-by: Random J Developer <random@developer.example.org>
to every commit message using your real name and a valid email address.
If you have set your user.name and user.email git config properties you can
automatically sign the commit by running the git-commit command with the -s
option. There may be multiple sign-offs if more than one developer was involved
in authoring the contribution.
For a more detailed description of this procedure, please see Submitting Patches which was extracted from the Linux kernel project, and which is stored in an external repository.
Often employers or academic institutions have ownership over code that is written in certain circumstances, so please do due diligence to ensure that you have the right to submit the code.
If you are a developer who is authorized to contribute to Carbyne Stack on
behalf of your employer, then please use your corporate email address in the
Signed-off-by tag. Otherwise, please use a personal email address.
Each contributor is responsible for identifying themselves in the NOTICE file, the project's list of copyright holders and authors. Please add the respective information corresponding to the Signed-off-by tag as part of your first pull request.
If you are a developer who is authorized to contribute to Carbyne Stack on
behalf of your employer, then add your company / organization to the list of
copyright holders in the NOTICE file. As author of a corporate
contribution, you must also add your name and corporate email address as in the
Signed-off-by tag.
If your contribution is covered by this project's DCO's clause "(c) The contribution was provided directly to me by some other person who certified (a) or (b) and I have not modified it", please add the appropriate copyright holder(s) to the NOTICE file as part of your contribution.