Pull Request Guide

This guide covers the process for submitting pull requests to AEGIS repositories, from branch creation through merge.

Before You Start

  1. Check for existing work — Search open issues and PRs to avoid duplicating effort
  2. Understand the scope — Make sure you are contributing to the right repository (see Repository Map)
  3. Follow conventions — Use conventional commits, descriptive branch names, and the project’s code style

Creating a Pull Request

1. Fork and Branch

# Fork the repo on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/aegis-docs.git
cd aegis-docs

# Create a descriptive branch
git checkout -b docs/add-deployment-guide

Use descriptive branch names that indicate the type and scope of the change:

2. Make Your Changes

3. Commit with Conventional Commits

git add .
git commit -m "docs: add deployment guide for self-hosted runtime"

Use the appropriate type prefix (feat:, docs:, fix:, chore:, refactor:). Write a clear, concise commit message that explains what changed.

4. Push and Open the PR

git push origin docs/add-deployment-guide

Then open a pull request on GitHub. In the PR description:

5. Review Process

PR Best Practices

Documentation PRs

For changes to this documentation site:

Further Reading