...
- 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!
Scripts
If a pattern in the code is recognized, the following may be scripts may be useful, or provide inspiration:
Code Block |
---|
sed -i 's/^[[:space:]]/ /' <file>
sed -i 's/^\t/ /' <file> |
File assignments
Each person has been allocated one "easy" file and one "hard" file ... except, Michel, who gets four "easies".
- Vitro Vitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java (checked but did not find any whitespace problems, code changes only. 20200401.sj)
- Vitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/fields/SelectListGeneratorVTwo.java
- Vitro: ./src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/HomePageController.java
- Vitro: ./src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/RDFServiceFactorySingle.java
- Thanks Nicolas Dickner !
- Vitro: ./apiVitro: ./src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/BaseEditElementVTwo.java - all updates in this file can be reverted (vitro-pr143, & added RootUserPolicy.java)
- VIVOVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddServiceProviderRoleToPersonGenerator.java (vivo-pr-154, & removed RootUserPolicy.java)
- VIVO VIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/visualization/utilities/CachingRDFServiceExecutor.java (vivo-pr-154)
- VIVOVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/visualization/utilities/VisualizationCaches.javajava (vivo-pr-154)
- Vitro Vitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/TemplateProcessingHelper.java (vitro-pr-146)
- VitroVitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/jena/model/RDFServiceModel.java (vitro-pr-147)
- Thanks Matthias Lühr !
- Thanks Nicolas Dickner !
- VIVOVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/visualizationconfiguration/capabilitymapgenerators/CapabilityMapRequestHandlerAddMemberRoleToPersonGenerator.java
- (vivo-pr-158)
- VIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddClinicalRoleToPersonGenerator.java (vivo-pr-158)
- VitroVitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaBaseDao.java (vitro-pr-152)
- VitroVitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/SparqlQueryDataGetter.java
- java (vitro-pr-152)
- VIVOVitro: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/servicesconfiguration/shortviewgenerators/FakeApplicationOntologyServiceAddOrganizerRoleToPersonGenerator.java (vivo-pr-151)
- VIVO: ./apiVIVO: ./src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddAttendeeRoleToPersonGeneratorAddPublicationToPersonGenerator.java
- (vivo-pr-153)
- VitroVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/editrdfservice/n3editing/configuration/generators/AddMemberRoleToPersonGenerator.javaimpl/RDFServiceFactorySingle.java (vitro-pr-141)
- VitroVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/editcontroller/n3editing/configuration/generators/AddClinicalRoleToPersonGenerator.java
- freemarker/HomePageController.java (vitro-pr-144)
- VitroVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/editservices/shortview/FakeApplicationOntologyService.java (vitro-pr-145)
- VIVO: ./apin3editing/configuration/generators/AddOrganizerRoleToPersonGenerator.javaVIVO: ./src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddPublicationToPersonGeneratorAddAttendeeRoleToPersonGenerator.java
Maxence Gévaudan
- (vivo-pr-155)
- VIVOVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddOutreachProviderRoleToPersonGenerator.java (vivo-pr-156)
- VIVOVIVO: ./api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/configuration/generators/AddReviewerRoleToPersonGenerator.java (vivo-pr-161)
Maxence Gévaudan
- Thanks Nicolas Dickner !