We strive for verbose and readable comments and docstrings. All code and documentation should follow our style guide. The hosted docs are automatically generated using Sphinx.
We follow a standard feature branch rebase workflow that prioritizes short PRs with isolated improvements.
Commits to main should only be made in the form of squash-merges from pull requests.
For example,
git checkout feature-branch
git add [files to be committed]
git commit -m 'Change summary'later, some new commits show up in main, so we rebase our branch
git pull --rebase origin main
git push -f feature-branchnow, we have completed our feature, so we create a PR to merge the branch into main
Once the PR is approved, we perform a final rebase, if necessary, and then a squash merge.
This means each PR results in a single commit to main.
Please provide a brief description of the PR in the summary instead of a list of commit strings.
We welcome contributions of new bot policies, alongside those in src/agent0/core/hyperdrive/policies.
Submit a pull request that meets the following criteria:
- Do something an existing policy doesn't already accomplish
- Be well-documented and follow our existing STYLEGUIDE.md.
- Pass all linting and type checks (the GH actions will check this for you).
- Describe the bot's behavior in a
describeclassmethod similarly to existing bots, ending in asuper().describe()call.
For code owners who wish to publish a release, make sure to follow these guidelines:
- Merge a PR that edits
pyproject.tomlto specify the new semver version. - From the updated
mainbranch, make a new tag withgit tag vX.Y.Z. - Push that tag to the remote repository with
git push --tags. - Go to the
releasestab in Github and add the new tag as a release. - Click the "Generate Release Notes" button to generate release notes.
- Add a brief summary under the "What's Changed" heading and create a "PRs" heading for the generated list of "PRs".