Contributing

We welcome contribution from everyone via the meta-cassini public Gitlab repository: https://gitlab.arm.com/cassini/meta-cassini. For general introduction about Cassini distribution, refer to Introduction.

License

The Cassini distribution is released under License.

Please use an SPDX license identifier in every source file following the recommendations to make it easier for users to understand and review licenses.

/* Copyright (c) 2022 Arm Limited or its affiliates. All rights reserved.
* SPDX-License-Identifier: MIT
*/

Contributing to Cassini distribution

This project uses the GitLab project forking workflow. By default, accounts on gitlab.arm.com do not have rights to create personal repositories and therefore fork existing projects. In order to contribute, users must first request access as described here.

Every commit must have at least one Signed-off-by: line from the committer to certify that the contribution is made under the terms of the Developer's Certificate of Origin.

The full text of Developer's Certificate of Origin can be found in sign-your-work-the-developer-s-certificate-of-origin. Due to the significance of the Developer's Certificate of Origin, part of it is copied below.

The sign-off is a simple line at the end of the explanation for the
patch, which certifies that you wrote it or otherwise have the right to
pass it on as an open-source patch.  The rules are pretty simple: if you
can certify the below:

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.

then you just add a line saying::

    Signed-off-by: Random J Developer <random@developer.example.org>

using your real name (sorry, no pseudonyms or anonymous contributions.)

Commit guidelines

Commits and patches added should follow the OpenEmbedded patch guidelines.

The component being changed in the shortlog should be prefixed with the layer name (without meta-), for example:

cassini-config: Decrease frobbing level

cassini-distro: Enable foobar v2

cassini-doc: Added foobar v2 documentation

Submitting changes

Thank you for your interest in contributing to Cassini distribution. To contribute, follow the instructions and ensure you adhere to commit guidelines.

Merge criteria

  • The merge request must receive at least 2 approvals from Cassini distro maintainers

  • meta-cassini pipelines are passed

  • No regression on code coverage