Split README.md to CONTRIBUTING.md to make it more user-facing #652
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
|
Great. Do you think "Testing" section should be moved to CONTRIBUTING.md as well? |
Current coverage is 61.94% (diff: 100%)@@ master #652 diff @@
==========================================
Files 150 150
Lines 15164 15164
Methods 0 0
Messages 0 0
Branches 3051 3051
==========================================
- Hits 9395 9394 -1
- Misses 4517 4518 +1
Partials 1252 1252
|
|
Probably yes, but since the README.md has mixed all over the place some parts that should go to CONTRIBUTING.md I initially start just splitting the file, I believe that both files will require a heavy lifting but I just start with a small change... If you wish I could start making the heavy lifting but it will take longer. |
|
Ok, let's merge this one and see how that would look like. |
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.
Initial commit to split README.md to the file CONTRIBUTING.md, this will allow improve README.md and make it more user-facing.
It's just an initial attempt to further improve the documentation, which will follow later improvements. Other projects have a CONTRIBUTING.md file, the README.md will be user oriented and CONTRIBUTING.md will be contributors/developer oriented.
Related: Issue 606