Skip to content

Commit

Permalink
Linting
Browse files Browse the repository at this point in the history
  • Loading branch information
breezy-codes committed Oct 21, 2024
1 parent 9456408 commit e687f3c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,9 @@ Splashkit Function: `function_name`
- [ ] Tested in Chrome and Firefox
```

Once submitted, move the associated planner card to peer review and link the pull request. Follow the [Planner Board Etiquette](/products/splashkit/splashkit-tutorials/onboarding/06-planner-board) for more details on the process.
Once submitted, move the associated planner card to peer review and link the pull request. Follow the
[Planner Board Etiquette](/products/splashkit/splashkit-tutorials/onboarding/06-planner-board) for
more details on the process.

### Peer Reviewing a Usage Example

Expand All @@ -221,4 +223,5 @@ I've reviewed the ...
- [ ] Python code ran correctly.
```
Ensure while doing peer reviews that you also follow the [Planner Board Etiquette](/products/splashkit/splashkit-tutorials/onboarding/06-planner-board) for moving tasks through the process.
Ensure while doing peer reviews that you also follow the [Planner Board Etiquette](/products/splashkit/splashkit-tutorials/onboarding/06-planner-board)
for moving tasks through the process.
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,48 @@ sidebar:

## Proper Planner Board Etiquette

The planner board is where all tasks are tracked. You can find tasks to claim and work on, or add your own tasks that you will complete. Here are some guidelines to ensure smooth teamwork and efficient use of the planner board.
The planner board is where all tasks are tracked. You can find tasks to claim and work on, or add
your own tasks that you will complete. Here are some guidelines to ensure smooth teamwork and
efficient use of the planner board.

### 1. Claiming a Task

- **Commit to work:** Only claim a task if you are ready to work on it.
- **Unclaim if needed:** If you are unable to proceed with a task you've claimed, unclaim it so others can take over.
- **Update status:** Once you claim a task, move it to the "Doing" column to signal that it's being actively worked on.
- **Unclaim if needed:** If you are unable to proceed with a task you've claimed, unclaim it so
others can take over.
- **Update status:** Once you claim a task, move it to the "Doing" column to signal that it's
being actively worked on.

### 2. Adding a Task

- **Be clear and concise:** When adding a task, provide a meaningful title and a detailed description.
- **Add checklists:** If the task involves multiple steps, include a checklist to outline them clearly.
- **Use appropriate tags:** Tag the task with relevant labels to categorise it properly, such as `Tutorials` if it's tutorial based, or `usage examples` if it's a usage example.
- **Use appropriate tags:** Tag the task with relevant labels to categorise it properly, such as
`Tutorials` if it's tutorial based, or `usage examples` if it's a usage example.

### 3. Moving Tasks

- **Include relevant links:** When completing a task, attach links to the pull request (PR) and any other relevant information.
- **Include relevant links:** When completing a task, attach links to the pull request (PR) and any
other relevant information.
- **Add a completion comment:** Leave a comment on the task card with the date you completed the task.
- **Move to Peer Review:** After completing a task, move it to the "First Peer Review" column so a team member can review it.
- **Move to Peer Review:** After completing a task, move it to the "First Peer Review" column so a
team member can review it.

> **Need help with pull requests?**
> Follow the [How to Create a Pull Request](/products/splashkit/splashkit-tutorials/onboarding/03-pull-request) guide.
> Follow the [How to Create a Pull Request](/products/splashkit/splashkit-tutorials/onboarding/03-pull-request)
guide for detailed instructions.

### 4. First Peer Review

- **Follow the review process:** Adhere to the steps outlined in the [Peer Review Guide](/products/splashkit/splashkit-tutorials/onboarding/05-peer-review).
- **Request changes if needed:** Provide feedback and request changes if required.
- **Approval:** Once the task meets the standards, approve it and the PR, then move the task to the "Second Peer Review" column.
- **Approval:** Once the task meets the standards, approve it and the PR, then move the task to the
"Second Peer Review" column.
- **Leave a comment:** Add a comment with the date and confirmation that you've approved the task.

### 5. Second Peer Review

- **Follow similar steps:** Conduct the second peer review following the same guidelines as the first.
- **Mentor Review:** After approving the PR, move it to the appropriate "Mentor Review" column.
- **Comment on approval:** As before, leave a comment with the date and a note indicating you've approved the task for mentor review.
- **Comment on approval:** As before, leave a comment with the date and a note indicating you've
approved the task for mentor review.

0 comments on commit e687f3c

Please sign in to comment.