InventAI
Community

Contributing

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for InventAI, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots or screen recordings which help you demonstrate the steps or point out the part which the suggestion is related to. You can use LICEcap to record GIFs on macOS and Windows, and the built-in screen recorder in GNOME or SimpleScreenRecorder on Linux.
  • Explain why this enhancement would be useful to most InventAI users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

We welcome your first code contribution! Here's how to get started:

  1. Fork the repository on GitHub and clone it to your local machine.
  2. Set up your development environment:
    • Make sure you have the required tools installed (e.g., Unity, .NET SDK, etc. as appropriate for the repo).
    • Run any setup scripts or install dependencies as described in the README or project documentation.
  3. Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch
  4. Make your changes in small, logical commits. Follow the Styleguides below.
  5. Test your changes locally. Run all tests and make sure your code builds and works as expected.
  6. Push your branch to your fork and open a Pull Request (PR) against the main repository.
  7. Describe your changes clearly in the PR description. Reference any related issues.
  8. Participate in code review:
    • Respond to feedback and make any requested changes.
    • Be polite and collaborative.
  9. Once your PR is approved and passes all checks, it will be merged by a maintainer.

Tips:

  • If you're unsure about anything, open a draft PR or ask a question in your PR description.
  • For larger changes, consider opening an issue first to discuss your approach.

Improving The Documentation

Good documentation is essential! Here's how you can help improve it:

  1. Find the documentation files in the inventaisil/docs repository.
  2. Fix typos, clarify explanations, or add missing information.
    • Use clear, concise language.
    • Add code examples or screenshots where helpful.
    • Keep formatting consistent (use markdown headings, lists, code blocks, etc.).
  3. For API docs:
    • Add or update XML doc comments in the code.
    • Run the documentation generator if the project uses one.
  4. Preview your changes locally if possible.
  5. Open a Pull Request with your improvements. Clearly describe what you changed and why.

Examples of valuable documentation contributions:

  • Adding usage examples
  • Improving setup instructions
  • Documenting edge cases or limitations
  • Translating docs to other languages

Styleguides

Code Style

  • C#:
    • Use Microsoft C# conventions.
    • Use XML documentation comments for public classes and methods.
    • Use PascalCase for class, method, and property names; camelCase for local variables and parameters.
    • Indent with 4 spaces.
    • Keep lines under 120 characters.
    • Add spaces around operators and after commas.
    • Use explicit access modifiers (public, private, etc.).
    • Group related code logically and use regions if appropriate.

Pull Requests

  • Make PRs small and focused. One feature or fix per PR.
  • Reference related issues in the PR description (e.g., Closes #123).
  • Add tests for new features or bugfixes if possible.
  • Ensure your branch is up to date with the target branch before requesting review.
  • Use clear, descriptive PR titles.

Commit Messages

  • Use the Conventional Commits style:
    • feat: add new batch image generation feature
    • fix: correct prompt formatting for AI requests
    • docs: update README with new setup instructions
  • Start with a lowercase type (feat, fix, docs, refactor, test, chore, etc.), followed by a colon and a short summary.
  • Use the imperative mood: "add" not "added" or "adds".
  • Include a body if more detail is needed, separated by a blank line.

Example:

feat: add batch image generation to Create menu

Allows users to generate multiple images for multiple prompts in one operation.

Attribution

This guide is based on the contributing.md!

SDK

Previous Page

License

Next Page

On this page