...
- Fork the VIVO and Vitro projects into your personal GitHub accounts (this is done in GitHub)
- Clone the VIVO and Vitro projects from your personal forks
Code Block language bash git clone https://github.com/<your-github-id>/VIVO.git git clone https://github.com/<your-github-id>/Vitro.git
- For whichever project contains the files you will be working (let's use 'VIVO' as the example), check out your own branch that is based on the sprint branch: 'sprint-i18n-whitespace'. It is recommended that you work on a branch that is based on the shared ('sprint-i18n-whitespace') branch so that you can continue to track updates from the team in 'sprint-i18n-whitespace' without having conflict with your current work.
Code Block language bash cd VIVO git checkout -b my-whitespace origin/sprint-i18n-whitespace
- Remove the extraneous whitespace updates in the 'my-whitespace' branch for the files that you have generously agreed to fix
- Note: Do whatever makes sense to you. My process is to:
- Use the GitHub pre-pull-requests linked below to identify which lines have updates that need to be reverted
- Use the `master` branch of VIVO (or Vitro) to see the file that you are working on. Sometimes whitespace was added; other times removed; sometimes spaces were replaced by tabs or vice versa. You will want to view the `master` branch version of the file to know what your whitespace goal is.
Code Block git checkout master cp <your-file> <some-location-outside-of-your-git-project>
- Use your `my-whitespace` version of your file to actually work on
Code Block git checkout my-whitespace vi <your-file>
- As you are making updates, you can check to see your progress by viewing the "diff" between the file in your `my-whitespace` branch and the file in the `master` branch
Code Block language cpp # Let's say the file you are working on is "AddAttendeeRoleToPersonGenerator.java" git diff my-whitespace master -- api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddAttendeeRoleToPersonGenerator.java
- Note: Do whatever makes sense to you. My process is to:
- Once you have removed all of the extraneous whitespace changes, commit your updates, and push to your personal GitHub fork
Code Block language cpp # See which files have been changed (hopefully only the ones you were working on) git status # Add the files to the upcoming commit git add . # Commit the changes locally git commit -m "Removed extraneous whitespace" # Push the commit to your personal GitHub fork git push origin my-whitespace:my-whitespace
- Now that you have an updated branch in your personal GitHub, you should submit a GitHub pull-request to the `sprint-i18n-whitespace` branch in the core VIVO or Vitro projects
- Celebrate! Success!
...