Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 4.25 KB

CONTRIBUTE.md

File metadata and controls

85 lines (64 loc) · 4.25 KB
Raw

How to contribute to OpenAGI

Thank you for your interest in OpenAGI! Here's a guide to help you contribute to this project.

1. Get Started

Fork the repository

At first, you need to fork this copy and create your own version of repo.

Clone the repository and install the dependencies.

Installing dependencies with pip

pip install -r requirements.txt

Installing pre-commit

We strongly recommend installing pre-commit to ensure proper formatting during development

2. Developing and Testing

Create a branch

Create a new branch for developing your creative features

git checkout -b your-feature

Make changes and testing

You can develop new features and then you need to make sure everything works as expected. Run our provided tests and make sure the existing ones go well. Your new tests are encouraged.

Run tests

Add your test code into the openagi/tests/ directory if any, then run test via pytest

cd openagi
pytest -v tests

sample output

============================================================================================================================= test session starts ==============================================================================================================================
platform darwin -- Python 3.11.9, pytest-8.1.1, pluggy-1.5.0 -- ""
cachedir: .pytest_cache
rootdir: ""
plugins: anyio-4.3.0
collected 2 items

tests/test_agent_creation.py::test_agent_creation PASSED                                                                                                                                                                                                                 [ 50%]
tests/test_tools.py::test_currency_converter_api PASSED                                                                                                                                                                                                                  [100%]

3. Submitting Changes

Code format check

Please ensure your code is formatted correctly using pre-commit

Git commit message

We strongly recommend your git commit follows the format below

git commit -m <type>: <subject>
feat Add new features
fix Fix bugs
docs Modify documents like README, CONTRIBUTE
style Modify code format like space and comma without changing code logic
refactor Refactor code structure without adding new features or fixing new bugs
perf Improve performance or user experience
test Test features, including unit test and integration test
chore Change the build procedure or add dependencies
revert Revert to the previous version

💡Try to shrink the number of git commit messages to make it clear and concise. If you find you have already made too many commit messages, no worries, use git rebase and squash to merge multiple messages. Here is the guide.

Create a Pull Request

  1. Visit your forked AIOS repository on GitHub and click the "Compare & pull request" button to initiate the process of submitting your changes to the original repository for review and potential merging.
  2. Choose the base branch and the compare branch (your feature branch).💡 Note that when you add new features, it is recommended to choose the (dev) branch and if your change does not affect original functions, you may consider choosing the (main) branch.
  3. Write a title and describe your changes in the description. And it is recommended to select the label of the change to make it more clear.

4. Review and Approval

Our maintainers will have a review of that and might give some suggestions or ask for more details. After they approve, your commitment can be incorporated into OpenAGI!