Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 3.2 KB
Raw

Contributing to agent0

Documentation

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.

Testing

We deploy a local anvil chain to run system tests. Therefore, you must install foundry as a prerequisite for running tests.

Testing is achieved with py.test. You can run all tests from the repository root directory by running python -m pytest, or you can pick a specific test with python -m pytest {path/to/test_file.py}. General integration-level tests are in the tests folder, while more isolated or unit tests are colocated with the files they are testing and end with a _test.py suffix.

Coverage

To run coverage locally you can follow these steps:

pip install coverage
coverage run -m pytest
coverage html

then just open htmlcov/index.html to view the report!

Contributor git workflow

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-branch

now, 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.

Contributing a new bot policy

We welcome contributions of new bot policies, alongside those in src/agent0/core/hyperdrive/policies.

Submit a pull request that meets the following criteria:

  1. Do something an existing policy doesn't already accomplish
  2. Be well-documented and follow our existing STYLEGUIDE.md.
  3. Pass all linting and type checks (the GH actions will check this for you).
  4. Describe the bot's behavior in a describe classmethod similarly to existing bots, ending in a super().describe() call.

Publishing a release

For code owners who wish to publish a release, make sure to follow these guidelines:

  1. Merge a PR that edits pyproject.toml to specify the new semver version.
  2. From the updated main branch, make a new tag with git tag vX.Y.Z.
  3. Push that tag to the remote repository with git push --tags.
  4. Go to the releases tab in Github and add the new tag as a release.
  5. Click the "Generate Release Notes" button to generate release notes.
  6. Add a brief summary under the "What's Changed" heading and create a "PRs" heading for the generated list of "PRs".