To contribute code or documentation, please submit a pull request.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. Before embarking on a more ambitious contribution, please get in touch.
Connect with us through https://alvearie.slack.com or open an issue. Access to the Alvearie Slack can be requested at https://alvearie.io/contributions/requestSlackAccess.
The project maintainers use GitHub reviews to indicate acceptance. A change requires approval from one or more maintainers for each component affected. Sometimes reviewers will leave a comment "LGTM" to indicate that the change "looks good to me".
We use the Developer's Certificate of Origin 1.1 (DCO) to ensure project pedigree.
We ask that, when submitting a patch for review, the developer include a sign-off statement to certify that:
(a) The contribution was created in whole or in part by them and they
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 their knowledge, is covered under an appropriate open source
license and they have the right under that license to submit that
work with modifications, whether created in whole or in part
by them, under the same open source license (unless they are
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to them by some other
person who certified (a), (b) or (c) and they have not modified
it.
(d) They understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information they submit with it, including their sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Here is an example Signed-off-by line:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -s