Thank you for your interest in contributing to AISim!
For the project overview, repository layout, setup, and development commands, see the AISim README. For focused AIConfigurator development instructions, see the application README.
- CI guide: workflows, code review, and required checks
- Good first issues
- Help wanted
- Open an issue
- Slack
- Office Hours
- Community Meetings (YouTube) -- Weekly (Wed 10:30 AM PT) development community meetings
AISim is an open source project released under the Apache 2.0 license (see either the Apache site or the LICENSE file). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
We respect the intellectual property rights of others and want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
The DCO is a declaration attached to every contribution made by every
developer. In the commit message of the contribution, the developer simply
adds a Signed-off-by statement and thereby agrees to the DCO, which you can
find below or at DeveloperCertificate.org.
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
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.
We require that every contribution to AISim is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors or those using pseudonyms.
Each commit must include a DCO sign-off that looks like this:
Signed-off-by: Jane Smith <jane.smith@email.com>
You may type this line yourself when writing your commit messages. If your
user.name and user.email are set in your Git configuration, you can use
-s or --signoff to add the Signed-off-by line to the end of the commit
message.
For example:
git commit -s -m "Describe your change"By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.