Contributing

We welcome your contributions to Assistant Engine! Here’s a quick guide to get started:

  • Learn the Structure: Assistant Engine is split into three projects (Assistant Engine.Web, Assistant Engine.UI, Assistant Engine.App). Take a moment to explore the code, configs, and docs.

  • Start Small: Great first contributions include:

  • Fixing typos or improving documentation

  • Bug fixes and small UI improvements

  • Minor refactors to get familiar with the codebase

  • Propose Larger Changes: For major features or architectural changes, open a GitHub issue first to discuss ideas with maintainers.

  • Branching: Always create a new branch from dev for your work.

git checkout dev
git pull origin dev
git checkout -b my-feature-branch

  • Commit Clearly: Use small, focused commits with descriptive messages:

  • Fix: Resolve null reference in SQL ingestion

  • Feat: Add dark mode toggle in web UI

  • Stay Synced: Regularly update your branch with the latest dev changes to avoid conflicts.

git checkout dev
git pull origin dev
git checkout my-feature-branch
git merge dev

  • Test Before Pushing: If tests exist, run them to ensure your changes don’t break anything.

  • Submit a PR: Once ready, open a pull request against the dev branch with:

  • A clear title (e.g., Feat: Add database ingestion status panel)

  • A short description of the problem and solution

The maintainers will review your PR, provide feedback, and help you land your contribution. 🎉