Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
174 lines (112 loc) · 4.96 KB

CONTRIBUTING.md

File metadata and controls

174 lines (112 loc) · 4.96 KB
Raw

Contributing to agentseek

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/ob-labs/agentseek/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Add Templates

Before contributing a bundled app template, follow Create a Template. Use the Template Authoring Contract to check configuration, lifecycle tasks, generated documentation, exceptions, and validation.

Write Documentation

agentseek could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/ob-labs/agentseek/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Issue Labels

We label issues along a few independent axes so you can filter the backlog. Pick a type and a component; the other axes are optional context.

GitHub labels are flat, so each axis is a name prefix sharing one color.

Type — what kind of work it is

  • bug — something isn't working
  • enhancement — new feature or request
  • documentation — docs additions or improvements
  • template-request — request for a new app template
  • question — further information is requested

comp: — which part of the project it touches

  • comp:cli — CLI commands and project lifecycle
  • comp:templates — app templates and the template registry
  • comp:skills — agent skills
  • comp:observability — tracing, logging, and observability
  • comp:runtime — AgentSeek runtime and project profile

priority: — backlog ordering

  • priority:high / priority:medium / priority:low

Most issues leave this unset; an absent priority is not a signal.

status: — workflow state

  • status:triage — needs initial review and scoping
  • status:needs-design — design or a decision is required before implementation
  • status:blocked — blocked by another issue or an external dependency

Newcomer signals

  • good first issue — small, well-scoped, and doable without deep knowledge of the codebase. The best place to start.
  • help wanted — open to outside contributors, but expect to need some product or domain knowledge.

Get Started!

Ready to contribute? Here's how to set up agentseek for local development. Please note this documentation assumes you already have uv and Git installed and ready to go.

  1. Fork the agentseek repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/agentseek.git
  1. Now we need to install the environment. Navigate into the directory
cd agentseek

Then, install and activate the environment with:

uv sync
  1. Install pre-commit to run linters/formatters at commit time:
uv run pre-commit install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Don't forget to add test cases for your added functionality to the tests directory.

  2. When you're done making changes, check that your changes pass the formatting tests.

make check

Now, validate that all unit tests are passing:

make test
  1. Before raising a pull request you should also run tox. This will run the tests across different versions of Python:
tox

This requires you to have multiple versions of python installed. This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.

  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.