Skip to content

949: Added workflow.md file #904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Arshadul-Monir merged 1 commit into from
Apr 16, 2026
Merged

949: Added workflow.md file #904

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/local/WORKFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Feature Workflow

Use this flow when handling a feature from assignment through merge and handoff.

## Workflow

1. Read the task description in Notion and understand the requested change/feature.
2. Set the Notion ticket status to `In Progress`.
3. Pull the latest `main` branch.
4. Create a local branch named exactly the Notion ticket ID.
Comment thread
Arshadul-Monir marked this conversation as resolved.
5. Make every commit message start with `<ticket-id>: `.
6. Open a pull request when the change/feature is completed.
7. Set the Notion ticket status to `Pending PR`.
Comment thread
Arshadul-Monir marked this conversation as resolved.
8. Add a clear PR description.
9. Add a screenshot from the development environment (if available).
10. Deploy the feature to staging (type /deploy in the PR comments).
Comment thread
Arshadul-Monir marked this conversation as resolved.
11. Add a screenshot from the staging environment (if available).
12. Ensure all PR checklist items are completed.
13. Resolve any Copilot suggestions.
14. Ping a reviewer on discord.
15. Resolve reviewer comments.
16. Rebase and merge the branch into `main`.
17. Set the Notion ticket status to `Done`.

## Notes

- Keep the branch name and commit prefix aligned with the same ticket ID.
- If screenshots are not available, note that in the PR description.
- Try to squash commits when possible.
- Example: If you have a commit like "checkstyle fix", squash it into the most relevant feature commit.
Loading