InvokeAI/docs/contributing/CONTRIBUTING.md
2023-07-20 09:35:09 +10:00

4.2 KiB
Raw Blame History

How to Contribute

Welcome to Invoke AI

Invoke AI originated as a project built by the community, and that vision carries forward today as we aim to build the best pro-grade tools available. We work together to incorporate the latest in AI/ML research, making these tools available in over 20 languages to artists and creatives around the world as part of our fully permissive OSS project designed for individual users to self-host and use.

Contributing to Invoke AI

Anyone who wishes to contribute to InvokeAI, whether features, bug fixes, code cleanup, testing, code reviews, documentation or translation is very much encouraged to do so.

To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the GitHub discussion board.

Areas of contribution:

Development

If youd like to help with development, please see our development guide. If youre unfamiliar with contributing to open source projects, there is a tutorial contained within the development guide.

Documentation

If youd like to help with documentation, please see our documentation guide.

Translation

If you'd like to help with translation, please see our translation guide.

Tutorials

Please reach out to @imic or @hipsterusername on Discord to help create tutorials for InvokeAI.

We hope you enjoy using our software as much as we enjoy creating it, and we hope that some of those of you who are reading this will elect to become part of our contributor community.

Contributors

This project is a combined effort of dedicated people from across the world. Check out the list of all these amazing people. We thank them for their time, hard work and effort.

Code of Conduct

The InvokeAI community is a welcoming place, and we want your help in maintaining that. Please review our Code of Conduct to learn more - it's essential to maintaining a respectful and inclusive environment.

By making a contribution to this project, you certify that:

  1. The contribution was created in whole or in part by you and you have the right to submit it under the open-source license indicated in this projects GitHub repository; or
  2. The contribution is based upon previous work that, to the best of your knowledge, is covered under an appropriate open-source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the same open-source license (unless you are permitted to submit under a different license); or
  3. The contribution was provided directly to you by some other person who certified (1) or (2) and you have not modified it; or
  4. You understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information you submit with it, including your sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open-source license(s) involved.

This disclaimer is not a license and does not grant any rights or permissions. You must obtain necessary permissions and licenses, including from third parties, before contributing to this project.

This disclaimer is provided "as is" without warranty of any kind, whether expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the contribution or the use or other dealings in the contribution.

Support

For support, please use this repository's GitHub Issues, or join the Discord.

Original portions of the software are Copyright (c) 2023 by respective contributors.


Remember, your contributions help make this project great. We're excited to see what you'll bring to our community!