streamline the readme/roadmap, add first principles to contributing #412
Conversation
This file contains hidden or 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
technoweenie
added a commit
that referenced
this pull request
Jun 19, 2015
streamline the readme/roadmap, add first principles to contributing
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
Nov 24, 2024
Our README file contains a brief note in its "Example Usage" section stating that Git LFS requires a Git version higher than 1.8.2 on Linux and 1.8.5 on macOS. This statement dates from commit 59a49b0 in PR git-lfs#412 in 2015, and so is relatively out of date. In particular, when we added support for the "git lfs migrate" command in PR git-lfs#2353, the actual minimum supported version of Git was changed from 1.8.x to 1.9.0 (in commit 1d0e834) and then to 2.0.0 (in commit 5aea841). These changes were made to the Travis CI configuration in use at the time, and later migrated to our current GitHub Actions CI workflow in commit c32820806229c3f42364d989f7a8597f73cb107ba of PR git-lfs#3808. This workflow continues to run our Git LFS test suite using Git 2.0.0. We therefore now update our README file to remove the outdated note about Git 1.8.x versions, and add a paragraph to the "Limitations" section which documents the current minimum supported Git version of 2.0.0 but also strongly advises the use of a more recent Git version.
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.
This streamlines the readme a bit. The contributing link is moved up. The high level feature descriptions are delegated to the feature page. The roadmap is also streamlined, so we can use issues to discuss details of the roadmap. The main addition is a section on the first principles behind the tool at the top of the contributing doc.