-
Notifications
You must be signed in to change notification settings - Fork 7
ReactJS Guidelines for creating a PR
**NOTE:** Any PR not adhering to these guidlines will be rejected
- branch name should have 4 segments, each separated by
/
:
(e.g.feature/react/1/bootstrap-react-project
)- type (feature/bug/enhancement/hotfix)
-
tech:
react
in our case - issue number
-
issue title in kebab-case
(i.e. lowercase, hyphen-separated)
- should be less than 80 characters
- should precisely summarize the issue
- should not contain branch name
- Should have bulleted points summarizing what's covered in this PR
-
Reviewer: Assign
Mayuri
as reviewer -
Assignees: Should be the person who is supposed to take next action
(e.g. when PR is raised, it's the reviewer. If PR is rejected, it's the developer) -
Projects: Select `ReactJS Frontend
-
Linked issues: Select the corresponding issue
-
Assign the label
react-frontend
-
Ensure there are no typos/spelling mistakes
-
Do NOT make 1 huge commit. Instead, make multiple small, self-sufficient commits
-
As a rule of thumb, each commit should correspond to 1 sub-task in your issue
-
Once commit is pushed, corresponding "sub-task" must be checked in the issue
-
Raise a PR (in
draft mode
) right after first commit -
When PR is ready for review, bring it out from the
draft mode
-
When configurations like
.gitignore
or.env.sample
are changed, create a separate commit for it -
Comments should ONLY be resolved by "project maintainer" (i.e. Mayuri or Sahil for this project)
-
After implementing the feedback from comments, update the PR and follow the same steps
Copyright © Josh Software Pvt. Ltd.