Skip to main content

Contributing to Unstract Open Source Edition

Welcome fellow contributor! Really glad to see you here. Even if this is your first time contribution, we are happy to get you started.

Join our LLM-powered automation community on Slack to have great conversations and reach out to the Unstract team.

Finally before you begin, please review and follow the Code of Conduct to make this a good experience for everyone involved.

Pull Request Workflow​

  1. Clone either the Unstract repo or your fork locally.
  2. Create a branch for your feature/fix with the format feat|fix/name (e.g. fix/workflow-execution).
  3. Make and commit your changes.
  4. Push your local branch to the Unstract repo or your fork.
  5. If maintaining a fork, submit a Pull Request from your forked repo main branch to the Unstract repo main branch. Otherwise submit a Pull Request from your feature branch to the Unstract repo main branch.
  6. Have a helpful PR title like feat: Improve workflow execution or fix: Workflow execution.
    Follow the PR template for detailed description.
    Link any relevant Issues.
  7. Unstract maintainers trigger the CI tests and review the PR.
    Collaborate to resolve any open conversations.
  8. PR is merged once all status checks pass and required number of approvals are obtained.

New Issue​

Report a Bug​

Go to New Issue page and click Get started button for Bug report. Follow the PR template for filing a bug report.

Request new Feature​

Go to New Issue page and click Get started button for Feature request. Follow the PR template for raising a feature request.

Report a Security Vulnerability​

Go to New Issue page and click Report a vulnerability button. This allows a vulnerability reporter to privately collaborate with Unstract maintainers following GitHub community best practices.