About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
development:making_pull_requests [2021/04/13 06:45] – Add suggestions and more information emaijaladevelopment: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 to making a good pull request.+On this page we provide a few suggestions on making a good pull request. You can also learn more about how pull requests fit into VuFind project management in our [[https://github.com/vufind-org/vufind/blob/dev/GOVERNANCE.md|Governance Document]].
  
 ===== Contents of a Good Pull Request ===== ===== Contents of a Good Pull Request =====
Line 33: Line 33:
  
   - First time only: "Fork" https://github.com/vufind-org/vufind to create your own copy of the repository.   - First time only: "Fork" https://github.com/vufind-org/vufind to create your own copy of the repository.
-  - Create a new branch based on the target branch (normally dev) and give it a desciptive name (e.g. dev-fix-config-comment)+  - Create a new branch based on the target branch (normally dev) and give it a descriptive name (e.g. dev-fix-config-comment)
   - 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 through the web interface.
   - 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:recommended_tools#tests|run some of the automated tests]] beforehand to make sure they pass.+You may also want to [[development:recommended_tools#meeting_project_standards|run some of the automated tests]] beforehand to make sure they pass.
  
 ==== 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, suggestions for refinement and other constructive comments that aim to maintain and improve quality. Humans, nonetheless, are fallible, so feel free to question the comments if you don't find them reasonable.+You may receive a request for further information or clarification, suggestions for refinement and other constructive comments that aim to maintain and improve quality. Humans, nonetheless, are fallible, so feel free to question the comments if you don't find them reasonable.  
 + 
 +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