Skip to content

armgit / camel

Public Imported from GitHub
0

๐Ÿซ CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

docs: Contribution guideline update (#602)

Wendong-Fan97cc631618af
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f09942f1..8de64507f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,6 +2,21 @@
Thank you for your interest in contributing to the CAMEL project! ๐ŸŽ‰ We're excited to have your support. As an open-source initiative in a rapidly evolving and open-ended field, we wholeheartedly welcome contributions of all kinds. Whether you want to introduce new features, enhance the infrastructure, improve documentation, asking issues, add more examples, implement state-of-the-art research ideas, or fix bugs, we appreciate your enthusiasm and efforts. ๐Ÿ™Œ You are welcome to join our [slack](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ) for more efficient communication. ๐Ÿ’ฌ
+## Join Our Community ๐ŸŒ
+
+### Schedule an Introduction Call ๐Ÿ“ž
+- English speakers: [here](https://calendly.com/roman-georgio/camel-ai-introduction-call?month=2024-05)
+- Chinese speakers: [here](https://calendly.com/sisi-qu/welcome-to-camel-onboarding-meeting?month=2024-05)
+
+### Developer Meeting Time & Link ๐Ÿ’ป
+- English speakers: Mondays at 5 PM GMT+1. Join via Zoom: [Meeting Link](https://kaust.zoom.us/j/91735108083)
+- Chinese Speakers: Mondays at 9 PM UTC+8. Join via Zoom: [Meeting Link](https://kaust.zoom.us/j/94271505221)
+
+### Our Communication Channels ๐Ÿ’ฌ
+- **Slack:** [Join here](https://join.slack.com/t/camel-ai/shared_invite/zt-2g7xc41gy-_7rcrNNAArIP6sLQqldkqQ)
+- **Discord:** [Join here](https://discord.gg/CNcNpquyDc)
+- **WeChat:** Scan the QR code [here](https://ghli.org/camel/wechat.png)
+
## Guidelines ๐Ÿ“
### Contributing to the Code ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป
@@ -15,7 +30,7 @@ If you're eager to contribute to this project, that's fantastic! We're thrilled
Make sure to mention any related issues and tag the relevant maintainers too. ๐Ÿ’ช
-Before your pull request can be merged, it must pass the formatting, linting, and testing checks. You can find instructions on running these checks locally under the **Common Tasks** section below. ๐Ÿ”
+Before your pull request can be merged, it must pass the formatting, linting, and testing checks. You can find instructions on running these checks locally under the **Common Actions** section below. ๐Ÿ”
Ensuring excellent documentation and thorough testing is absolutely crucial. Here are some guidelines to follow based on the type of contribution you're making:
@@ -31,8 +46,10 @@ Ensuring excellent documentation and thorough testing is absolutely crucial. Her
We're a small team focused on building great things. If you have something in mind that you'd like to add or modify, opening a pull request is the ideal way to catch our attention. ๐Ÿš€
-### Issues ๐Ÿ›๐Ÿ†™๐ŸŒŸ
+### Board Item Create Workflow ๐Ÿ› ๏ธ
+At CAMEL, we manage our project through a structured workflow that ensures efficiency and clarity in our development process. Our workflow includes stages for issue creation and pull requests (PRs), sprint planning, and reviews.
+#### Issue Item Stage:
Our [issues](https://github.com/camel-ai/camel/issues) page on GitHub is regularly updated with bugs, improvements, and feature requests. We have a handy set of labels to help you sort through and find issues that interest you. Feel free to use these labels to keep things organized.
When you start working on an issue, please assign it to yourself so that others know it's being taken care of.
@@ -41,6 +58,41 @@ When creating a new issue, it's best to keep it focused on a specific bug, impro
We do our best to keep these issues up to date, but considering the fast-paced nature of this field, some may become outdated. If you come across any such issues, please give us a heads-up so we can address them promptly. ๐Ÿ‘€
+Hereโ€™s how to engage with our issues effectively:
+- Go to [GitHub Issues](https://github.com/camel-ai/camel/issues), create a new issue, choose the category, and fill in the required information.
+- Ensure the issue has a proper title and update the Assignees, Labels, Projects (select Backlog status), Development, and Milestones.
+- Discuss the issue during team meetings, then move it to the Analysis Done column.
+- At the beginning of each sprint, share the analyzed issue and move it to the Sprint Planned column if you are going to work on this issue in the sprint.
+
+#### Pull Request Item Stage:
+
+- Go to [GitHub Pulls](https://github.com/camel-ai/camel/pulls), create a new PR, choose the branch, and fill in the information, linking the related issue.
+- Ensure the PR has a proper title and update the Reviewers (convert to draft), Assignees, Labels, Projects (select Developing status), Development, and Milestones.
+- If the PR is related to a roadmap, link the roadmap to the PR.
+- Move the PR item through the stages: Developing, Stuck, Reviewing (click ready for review), Merged. The linked issue will close automatically when the PR is merged.
+
+**Labeling PRs:**
+- **feat**: For new features (e.g., `feat: Add new AI model`)
+- **fix**: For bug fixes (e.g., `fix: Resolve memory leak issue`)
+- **docs**: For documentation updates (e.g., `docs: Update contribution guidelines`)
+- **style**: For code style changes (e.g., `style: Refactor code formatting`)
+- **refactor**: For code refactoring (e.g., `refactor: Optimize data processing`)
+- **test**: For adding or updating tests (e.g., `test: Add unit tests for new feature`)
+- **chore**: For maintenance tasks (e.g., `chore: Update dependencies`)
+
+### Sprint Planning & Review ๐ŸŽฏ
+
+#### Definition
+
+Sprint planning defines what can be delivered in the sprint and how it will be achieved. Sprint review allows stakeholders to review and provide feedback on recent work.
+
+#### Practice
+
+- **Sprint Duration**: Two weeks for development, one week for review.
+- **Sprint Planning & Review**: Conducted biweekly during the dev meeting (around 30 minutes).
+- **Planning**: Founder highlights the sprint goal and key points; developers pick items for the sprint.
+- **Review**: Feedback on delivered features and identification of improvement areas.
+
### Getting Help ๐Ÿ†˜
Our aim is to make the developer setup as straightforward as possible. If you encounter any challenges during the setup process, don't hesitate to reach out to a maintainer. We're here to assist you and ensure that the experience is smooth not just for you but also for future contributors. ๐Ÿ˜Š
@@ -62,16 +114,19 @@ cd camel
poetry shell
# Install camel from source
-# It takes about 75s to resolve dependencies and 10s to install them, depending on your hardware and network,
+# It takes about 75s to resolve dependencies and 10s to install them, depending on your hardware and network
poetry install --with dev,docs
# Or if you want to use all other extra packages
-poetry install --with dev,docs -E all # (Optional)
+poetry install --with dev,docs -E all # (Suggested for developers)
# The following command installs a pre-commit hook into the local git repo,
# so every commit gets auto-formatted and linted.
pre-commit install
+# Run camel's pre-commit before push
+pre-commit run --all-files
+
# Run camel's unit tests
pytest test
@@ -127,7 +182,7 @@ pytest --cov --cov-report=html
The coverage report will be generated at `htmlcov/index.html`.
-#### Tests ๐Ÿงช
+### Tests ๐Ÿงช
Unit tests cover modular logic that doesn't require calls to outside APIs. Currently, the test setup requires an OpenAI API key to test the framework, making them resemble integration tests.