Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:making_pull_requests
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
development:making_pull_requests [2021/04/13 06:45] – Add suggestions and more information emaijala | development:making_pull_requests [2022/04/11 16:16] (current) – [What Happens to a Pull Request] emaijala | ||
---|---|---|---|
Line 5: | Line 5: | ||
Anyone may and is encouraged to make and contribute to pull requests. Since VuFind is so flexible, a lot of libraries add custom functionality to their instances. We're thrilled when developers share this code back with us! | Anyone may and is encouraged to make and contribute to pull requests. Since VuFind is so flexible, a lot of libraries add custom functionality to their instances. We're thrilled when developers share this code back with us! | ||
- | On this page we provide a few suggestions | + | On this page we provide a few suggestions |
===== Contents of a Good Pull Request ===== | ===== Contents of a Good Pull Request ===== | ||
Line 33: | Line 33: | ||
- First time only: " | - First time only: " | ||
- | - Create a new branch based on the target branch (normally dev) and give it a desciptive | + | - Create a new branch based on the target branch (normally dev) and give it a descriptive |
- Make the changes in this new branch, commit and push them to your repository in GitHub. | - Make the changes in this new branch, commit and push them to your repository in GitHub. | ||
- | - Go to GitHub and start a new pull request. | + | - Go to GitHub and start a new pull request |
- Make sure base repository and base are correct. | - Make sure base repository and base are correct. | ||
- Enter a description about what has been done and why. It's often useful to provide a short use-case when it's not obvious from the change. | - Enter a description about what has been done and why. It's often useful to provide a short use-case when it's not obvious from the change. | ||
Line 41: | Line 41: | ||
- Submit the pull request. | - Submit the pull request. | ||
| | ||
- | You may also want to [[development: | + | You may also want to [[development: |
==== What Happens to a Pull Request ==== | ==== What Happens to a Pull Request ==== | ||
Line 58: | Line 58: | ||
* Accessibility | * Accessibility | ||
| | ||
- | You may receive a request for further information or clarification, | + | You may receive a request for further information or clarification, |
+ | |||
+ | If you've done changes requested in a review, please re-request review from the same person. This ensures that the pull request gets attention. | ||
When everything checks out and all requirements are fulfilled, the pull request will get merged. After it has been merged, you can delete your own branch. It's a good idea to clean up obsolete branches regularly. | When everything checks out and all requirements are fulfilled, the pull request will get merged. After it has been merged, you can delete your own branch. It's a good idea to clean up obsolete branches regularly. | ||
Line 101: | Line 103: | ||
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
development/making_pull_requests.1618296344.txt.gz · Last modified: 2021/04/13 06:45 by emaijala