Creating a Pull Request - bounswe/bounswe2017group3 GitHub Wiki
Since we'll be using issue and pull request systems a lot, we should try to be efficient and consistent while using them. This document explains the format and content of a pull request, as well as the pre and post processes.
Before Creating a Pull Request
- Please follow our contribution guide.
Creating a Pull Request
- Be consistent with our pull request template.
- Fill in as much of our pull request template as you can.
- You must give a brief explanation of your pull request in the
Aboutpart and you can't remove that block. - You must mention the changes you've made.
- Don't forget to add all the pull request and issue links to the part in
About.
- You must give a brief explanation of your pull request in the
- Remove the parts that are not related to your pull request. For example; if there is no visuality related to your pull request, remove the
## Visualsblock completely.
- Fill in as much of our pull request template as you can.
- Choose your base branch as
master.- We don't use a temporary development branch and don't make releases in intervals. We use a continuous integration tool to test and deploy our
masterbranch automatically in real-time to our production environment.
- We don't use a temporary development branch and don't make releases in intervals. We use a continuous integration tool to test and deploy our
- When your pull request is in the review status, assign it to a person or multiple people to get a review.
- You must have at least one approved review to merge your branch.
- Your pull request must have one and only one status label at all times while it is open. Track the status of your pull request and tag it with the relevant status label.
- When you close your pull request, don't forget to remove the status label.
- You must tag your pull request with at least one non-status label and you must add all the relevant labels. To find out which labels are suitable, you can use the Choosing the Right Labels part.
- Include screenshots and animated GIFs in your pull request whenever possible in the
Visualspart.
After Creating a Pull Request
- Add the pull request to the relevant column in our Kanban board.
(To open our board: Go toProjectstab in GitHub and choose theInterest Based Communitiesproject)
- To add your pull request to the board: In the upper right part of our board, click on the
Add cardsbutton and drag your pull request to the column that matches its status label.
- Whenever your pull request status changes, don't forget to change the place of your pull request in the Kanban board.
- To add your pull request to the board: In the upper right part of our board, click on the
- Follow the review process and make the necessary changes if a reviewer request changes.
Choosing the Right Labels
backend: Backend related pull request: API, database, server etc.
design: Design or sketch related pull request: Mockups, diagrams, UI designs etc.
frontend: Frontend related pull request: UI design implementations etc.
help wanted: Pull request that needs help from others to complete.
status: in progress: Pull request that is currently being done.
status: review: Pull request that is complete and under review.
type: bug: Bug related pull request: Browser-specific bugs in UIs, backend bugs etc.
type: enhancement: Enhancement related pull request: Enhancing the requirements, enhancing an old feature etc.
type: feature: Feature related pull request: Creating something new, adding a new feature etc.
memo: Documentation related pull request.