🤝Agile Documentation & Updates

[Wendong-Fan]

Agreement:

1. Always follow the agreement, everyone has the right to propose new agreements or changes to established agreements
2. Always ok to say "no updates", but when you need support, ask for it as early as possible
3. Write down every task you are doing into a issue item, the item should also follow the templet
4. Estimate the effort required for each item, and split the item which may take more than 1 week effort into smaller items

Board Item Create Workflow:

The Board item creation workflow mainly has two stages.

Issue Item Stage

1. Go to https://github.com/camel-ai/camel/issues, create a new issue.
2. Choose the category of the issue, then click ‘Get started’, fill in the information.
3. After the issue is created, make sure your issue have proper title and remember to change the Assignees, Labels, Projects(select the status as Backlog), Development, Milestones in the right side bar.
4. Open and analysis this issue with all teammates in the during the team meeting, then move it to Analysis Done column.
5. At the beginning of each sprint, share the analyzed issue you wish to complete in this sprint with teammates, and move the issue to the Sprint Planned column.

Pull Request Item Stage

1. Go to https://github.com/camel-ai/camel/pulls, create a new PR.
2. Choose the branch you are going to work on and fill in the information into the template, link the issue you created under Related Open Issue or User Stories.
3. Make sure your PR have proper title and remember to change the Reviewers(also click convert to draft), Assignees, Labels, Projects(select the status as Developing), Development, Milestones in the right side bar.
4. If your PR is related to one roadmap, please also link the roadmap to this PR.

When the set of two stages is done, you only need to move the PR item from Developing to Stuck, Reviewing(remember click ready for review), Merged. The issue item you linked with PR item will be closed automatically when the PR item is successfully merged, so always make sure you have linked the issue item you created in the PR item.

Sprint Planning & Review

Definition Sprint planning is an event that kicks off the sprint(a set period of time where all the work is done). The purpose of sprint planning is to define what can be delivered in the sprint and how that work will be achieved.

Sprint review is is an event that stakeholders review and provide feedback on the most recent work.

Practice (proposed)

1. Take two weeks as one sprint, do Sprint Planning & Review biweekly in the dev meeting (around 30 mins)
2. For Sprint Planning, Product Owner highlights the sprint goal and key points, select items to include in the current sprint. Developers pick items they want to finish in the current sprint.
3. For Sprint Review, Product Owner and Developers provides feedback on the delivered features and areas for improvement.

About Meeting Facilitator:

Teammates take turns to be the facilitator of meeting, name list can be seen in https://github.com/orgs/camel-ai/projects/1/views/2?pane=issue&itemId=38823847, feel free to add your name in below as the volunteer.

Task for facilitator

1. Check with teammates if there is any issue item in Backlog column needs to be analyzed, move the issue item analyzed into Analysis Done column.
2. Go through all PR items in the Developing column, let the assignees of each PR item share main updates.
3. Go through all PR items in the Stuck column, make sure all teammates understand the block reason, call for possible team work support.
4. Go through all PR items in the Reviewing column, let the owners of each PR item share status, boost the cooperate between assignees and reviewers.
5. When going through the board, check the label of all items, make sure all items are in the right status column, if it’s not right, remind the assignee to fix it.

reference: https://www.atlassian.com/agile/manifesto

[Wendong-Fan]

Convert this into issue to allow the use of comment for update

[Wendong-Fan]

1. Delete template in backlog since it will be moved into PULL_REQUEST_TEMPLATE in Repo
2. Change the 'Development Completed' column to 'Reviewing', description: Items need to be reviewed by other teammates and may need some adjustment work
3. Change the 'Shipped' column to 'Merged', description: Items have been merged successfully to the main branch, great work!

[Wendong-Fan]

Move all 'No Status' issues into 'Backlog'

[Wendong-Fan]

Add Board Item Create Workflow, About Meeting Facilitator Doc

[149189]

Hey! I want to work on this issue

[Wendong-Fan]

Hi @149189 ,

Thank you for your enthusiastic willingness to contribute! While this isn't an actual issue, it serves as a documentation space for the Agile methodology we're currently implementing. If you're interested in making contributions to CAMEL in other areas, please feel free to get in touch with @lightaime . Your participation is greatly appreciated.

[Wendong-Fan]

added sprint practice

[Wendong-Fan]

need introduction how we manage the project, how to contribute, how to set up a call with maintainers, meeting time&link, how to join developer meeting, where's our slack & discord & wechat channel, how to use it.

[Wendong-Fan]

introduce how to label the PR like feat:xxx