First off, thank you for considering contributing to AI Playground. It's people like you that make this project such a great tool. We welcome contributions from everyone as long as they follow the guidelines below.
AI Playground has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
There are many ways to contibute to this project, from writing tutorials or blog posts (Show and tell in Discussion), improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into this project itself.
Before submitting bug reports, please check the issue tracker to make sure the bug hasn't been reported before. If it is a new bug, please provide as much detail as possible, including:
- A clear and descriptive title
- The exact steps which reproduce the problem
- Your environment (OS, GPU, CPU, etc.)
- Any related files or screenshots
Enhancement suggestions (feature requests) are also tracked as GitHub issues. When suggesting an enhancement, please:
- Use a clear and descriptive title
- Provide a step-by-step description of the suggested enhancement
- Explain why this enhancement would be useful to most AI Playground users
If you are not familiar with pull requests, you could get started with GitHub tutorials: Collaborate with pull requests.
The process described here has several goals:
- Maintain the quality of this project
- Fix problems that are important to users
- Engage the community in working toward the best possible AI Playground
- Enable a sustainable system for AI Playground's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Always set base branch to dev, do NOT make pull requests to the main branch without a strong reason.
- Follow all instructions in the template.
- After you submit your pull request, verify that all status checks are passing.
- Sign your work.
While the prerequisites above must be satifisfied prior to have your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
Discussions about AI Playground take place on this repository's Issues, Pull Requests and Discussions. Anybody is welcome to join these conversations.
AI Playground is licensed under the terms in LICENSE. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch 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 (from developercertificate.org):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA
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.
Then you just add a line to every git commit message:
Signed-off-by: Joe Smith <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your user.name and user.email git configs, you can sign your
commit automatically with git commit -s.
Again, thanks for your interest in contributing to this project. We appreciate your efforts to make our project even better!