Our project welcomes contributions from developers and organizations from all over the world. Our project is dedicated to creating a multi-agent development platform for all users, so whether you are an expert in your field or a regular user of the project, we welcome you to participate in shaping the future of this project. You can get involved in the project in the following ways:
- Write / translate / fix our documentation
- Raise questions / Answer questions
- Provide demos, examples or test cases
- Give suggestions or other comments
- Paticipate in issues or discussions
- Pull requests
- Sharing related research / application
- Any other ways to improve OxyGent
For developers who want to contribute to our code, here is the guidance:
- Issues with label
PR welcome, which means:- A reproducible bug
- A function in plan
- We strongly suggest you to read our Document before developing
- For setting environment, please check our Readme file
- You could run our demo to check whether the requirements are successfully installed:
python demo.py python -m examples.agents.demo_single_agentWe provide some tests to check your code before pull request.
- Before testing, you should install
pytest:
pip install pytest pytest-asyncio- Format code:
ruff format .
docformatter -r -i --wrap-summaries 88 --wrap-descriptions 88 oxygent/- Unit test:
pytest oxygent/test/unittest- Integration test (Optional):
pytest oxygent/test/integrationAfter the PR is submitted, we will format and test the code. Our tests are still far from perfect, so you are welcomed to add tests to our project!