New Contributor Guide#
If you're a new contributor to InvokeAI or Open Source Projects, this is the guide for you.
New Contributor Checklist#
- Set up your local development environment & fork of InvokAI by following the steps outlined here
- Set up your local tooling with this guide. Feel free to skip this step if you already have tooling you're comfortable with.
- Familiarize yourself with Git & our project structure by reading through the development documentation
- Join the #dev-chat channel of the Discord
- Choose an issue to work on! This can be achieved by asking in the #dev-chat channel, tackling a good first issue or finding an item on the roadmap. If nothing in any of those places catches your eye, feel free to work on something of interest to you!
- Make your first Pull Request with the guide below
- Happy development! Don't be afraid to ask for help - we're happy to help you contribute!
How do I make a contribution?#
Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
Before starting these steps, ensure you have your local environment configured for development.
- Find a good first issue that you are interested in addressing or a feature that you would like to add. Then, reach out to our team in the #dev-chat channel of the Discord to ensure you are setup for success.
- Fork the InvokeAI repository to your GitHub profile. This means that you will have a copy of the repository under your-GitHub-username/InvokeAI.
- Clone the repository to your local machine using: GitHub Desktop is a easy-to-use alternative with a UI. You can do all the same steps listed here, but through the interface.
- Create a new branch for your fix using:
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index:
- Store the contents of the index with a descriptive message.
- Push the changes to the remote repository using
- Submit a pull request to the main branch of the InvokeAI repository. If you're not sure how to, follow this guide
- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #1234".
- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
- Wait for the pull request to be reviewed by other collaborators.
- Make changes to the pull request if the reviewer(s) recommend them.
- Celebrate your success after your pull request is merged!
If you’d like to learn more about contributing to Open Source projects, here is a Getting Started Guide.
- Keep your pull requests small. Smaller pull requests are more likely to be accepted and merged
- Comments! Commenting your code helps reviewers easily understand your contribution
- Use Python and Typescript’s typing systems, and consider using an editor with LSP support to streamline development
- Make all communications public. This ensure knowledge is shared with the whole community
Where can I go for help?#
If you need help, you can ask questions in the #dev-chat channel of the Discord.
For frontend related work, @pyschedelicious is the best person to reach out to.
Created: July 19, 2023