-
Notifications
You must be signed in to change notification settings - Fork 3
What is a Pull request ?
Pull requests let you tell others about changes you've pushed to a branch in a repository.
Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the dev
branch.
After you have committed changes and published a new branch you will have to create a pull request to let the team review the changes before they are applied to the dev
branch if accepted, team member may also comment and suggest modification(s).
When you have published a branch with new commits you will have a button to create a new Pull request
(On the web version and in Github Desktop app)
- Enter a proper title for your pull request that will appear in the changelog
- Optionally, select one or multiple
reviewer(s)
if the feature is related specifically to a team member (Leave empty if you are not sure) - Optionally, select one or multiple
assignee(s)
that will be in charge of the final merge (Leave empty if you are not sure) - Select all the
labels
appropriate for the Pull request - Select the
project
that this Pull request is related to - Enter details in the description field for additional information about the changes
- Click
Create Pull request
- Open the Pull request page and check the commit(s) and conversation history
- Check the code to be added and make sure it follow the Coding Convention
- Set the branch as active on your local machine
- Test the new feature in your game
- Click on
Add your review
on the top of the Pull request page
(Only available if you are assigned as a reviewer)
- The
assignee
should be the developer and/or the contributor of the feature - The
assignee(s)
should/must also review the changes - When everything is alright the
assignee
will create a merge into the appropriate branchdev
,release-*
Sometime when merging a Pull request a conflict can happen, this mean that a more recent merge modified one or more of the same files.
Clicking on resolve conflict will let you fix any conflict, if you are unsure what to do request help from a team member.
- Setup (Unavailable)
- Branches
- Issues
- Pull requests
- Projects
- Contributing
- Mod best practices (Unavailable)
- Setting up a git repo (Unavailable)
- Mod Template (Unavailable)
- Scenario Template (Unavailable)
- Create scenarios (Unavailable)
- Create maps (Unavailable)
- Create items (Unavailable)
- Create clothings (Unavailable)
- Create IsoObjects (Unavailable)
- Use CommunityAPI (Unavailable)
- Automated Workshop (Unavailable)
- API Structure
- Coding Convention
- API best practices (Unavailable)
- Finishing your new API (Unavailable)
- 3D Models for PZ (Unavailable)
- Animations for PZ (Unavailable)