Update AboutUs, ContactUs, UserGuide, DeveloperGuide, FileName.java and FileNameTest.java #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the Github project url Fix formatting
Update Github url Improve description in ContactUs.adoc
Update UserGuide.adoc for consistency
Update DeveloperGuide.adoc for consistency Improve description for the export command
Improve Introduction description Improve Exporting as CSV file format description
Update Github url
Update package url for commons with the correct package url
Update DeveloperGuide.adoc who updated prerequisites which recommends JDK 9 with a note on why JDK 11 and later are not supported/recommended Improve description for setting up the project Ensure consistency in DeveloperGuide.adoc
Update Section Headers in DeveloperGuide.adoc to ensure consistency
Update DeveloperGuide.adoc Export command Description to ensure consistency
Upload ExportCommandActivityDiagram.png for Export Command Implementation description in DeveloperGuide.adoc
Update DeveloperGuide.adoc Exporting to CSV file format description Update export command description to include ExportCommandActivityDiagram.png
Improve FileName.java class description to include more detailed information on File Naming Conventions including certain platform unique restrictions and suggestions on what Java build in classes which can complement with this class to help solve potentially platform unique issues involving file names Improve isValidFileName() method's String parameter name to be more descriptive Add requireNonNull() check in the isValidFileName() method implementation to ensure that the argument passed to isValidFileName parameter is non null
Update FileName.java description with reserved names which are not allowed in Windows as file names with the relevant documentations to explain why they are not allowed Add a new constant String variable RESERVED_NAMES_REGEX which contains the regex pattern to check for reserved names which are not allowed as file names in Windows based on Windows documentation. Include additional reserved names not allowed by Windows but not included in Windows documentation: COM0 and LPT0 (These were found based on personal manual testing on Windows 10) Add additional JUnit test cases to test for the reserved names not allowed by Windows as file names in FileNameTest.java These updates to FileName.java and FileNameTest.java is to ensure portability, in other words, making the file name validation platform independent
JonathanLeeWH
added
type.Enhancement
Update ExportCommandActivityDiagram.png
JonathanLeeWH
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update AboutUs.adoc with updated Github project url
Update ContactUs.adoc with improved description and updated Github project url
Update UserGuide.adoc with improved Introduction section description, improved Exporting as CSV file format description, ensure consistency, updated Github project url
Update DeveloperGuide.adoc with updated prerequisites which recommend JDK 9 with a note on why JDK 11 and later are not supported/recommended, improved description for setting up the project, ensure consistency, update package url for commons with the correct package url, updated section headers for consistency and updated Exporting to CSV file format description with ExportCommandActivityDiagram.png.
Upload ExportCommandActivityDiagram.png
Update FileName.java with improved FileName.java class description to include more detailed information on File Naming Conventions including certain platform unique restrictions and suggestions on what Java build in classes which can complement with this class to help solve potentially platform unique issues involving file names
Improve isValidFileName() method's String parameter name to be more descriptive
Add requireNonNull() check in the isValidFileName() method implementation to ensure that the argument passed to isValidFileName parameter is non null
Update FileName.java description with reserved names which are not allowed in Windows as file names with the relevant documentations to explain why they are not allowed
Add a new constant String variable RESERVED_NAMES_REGEX which contains the regex pattern to check for reserved names which are not allowed as file names in Windows based on Windows documentation.
Include additional reserved names not allowed by Windows but not included in Windows documentation: COM0 and LPT0 (These were found based on personal manual testing on Windows 10)
Add additional JUnit test cases to test for the reserved names not allowed by Windows as file names in FileNameTest.java
These updates to FileName.java and FileNameTest.java is to ensure portability, in other words, making the file name validation platform independent