Final Changes Made to Contributing.md to Address Issue #4 #188
Conversation
* Added Tool Versions to Contributing * Minor style changes to Contirbuting file * Minor style changes to Contirbuting file 2.0
There was a problem hiding this comment.
Why are some tools specified with versions and other tools not?
For example, why is there no version number associated with Git? (I am not suggesting that there should be, but it calls into question the utility of such information or lack thereof.)
It seems like there ought to be a rationale for specifying a particular version number or a minimal/maximal version number (e.g., "Version 2.0 or higher", "Version 2.0 or lower").
| ### Apache Ant: Version 1.10.7 | ||
| * Note: Version 1.10.7 does not allow the user to execute | ||
| ``` | ||
| $ ant test | ||
|
|
||
| ``` | ||
| * However, Version 1.10.12 does allow the test to run. |
There was a problem hiding this comment.
Given this note and the fact that Apache Ant is not part of the repository, why not simply specify that Version 1.10.12 is the version to be used?
That also obviates the need for lines showing $ ant test.
| $ cd build | ||
|
|
||
| ``` | ||
| ### Java: Version 11.0.14.1 |
There was a problem hiding this comment.
This version numbering seems to be overly specific. The implication is that the product works only with this version of Java. Is that true? If not, then why specify that particular version of Java? (Note that Java is not included in the product repository.)
| #### Gson: Version 2.8.5 | ||
| * [GSon](https://github.com/google/gson) |
There was a problem hiding this comment.
If this knowledge is important, it seems like it is also important to know which tools use it.
Likewise for each of the tools only used by other tools and not directly invoked by the build itself.
|
No response in over 30 days. Converting to draft. |
Will delete if no response within the next 14 days or if an alternative PR addresses the issues. |
Addresses Issue
Our team reviewed the code and existing documentation to make a list of technologies that are involved in the Redistricting project. This includes many of the larger and more important tools used in this project.
Our work was strictly in the Contributing.md file found in the main folder. Our work was on lines 30-79 in this file. Due to issues with ctrl+m carriage returns (invisible characters), the whole file was updated, but nothing was changed except for the lines we worked on.