👋Hi guys,
Today, I'd like to share an important point with you.
While working individually allows for flexibility, adhering to standards when collaborating in a team yields significant benefits. If you're facing challenges in standardizing merge requests, I recommend checking out this informative article.
It provides valuable insights and guidance on how to streamline the process.
Let's find out!
Merge Request Template
Following a merge request template provides the following advantages for an efficient workflow:
- Consistency: A template ensures that all merge requests have a standardized structure.
- Time Savings: It saves time by providing a predefined format for including necessary information.
- Clear Communication: Templates promote clear and concise descriptions of changes.
- Documentation: They serve as documentation for future reference and code maintenance.
- Improved Collaboration: Templates facilitate effective collaboration between contributors and reviewers.
- Efficient Code Reviews: They streamline the code review process by providing all required information upfront.
Merge request template
MR title
Describe brief your changes (should follow git commit guideline).
Ex: fix(game): disable add more game action after successful payment (!592)
Proposed changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
JIRA
Put list of jira tasks in the following format
- [JIRA Task Title](JIRA links)
Types of changes
What types of changes does your code introduce?
Put an x in the boxes that apply
- Bugfix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Documentation Update (if none of the other choices apply)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
- Lint and unit tests pass locally with my changes
- I have added tests that prove my fix is effective or that my feature works
- I have added necessary documentation (if appropriate)
Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
