Rework README and CONTRIBUTING documents #1023
Merged
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
ferd
force-pushed
the
rework-repo-docs
branch
5 times, most recently
from
372332b to
b69857d
Compare
- The README is better targetted to newcomers and explains the basics of the project: what it is, why use it, how to get started, where to find more information. It looks less like a reference and more like a brief overview of rebar3. - Whatever looks like a list or reference manual material is expected to be moved to the website - Be clearer about the rebar3 project structure in CONTRIBUTING.md; explain how to write tests, how to structure code, and so on. - Added contributing section on bug reports, feature requests, etc.
ferd
force-pushed
the
rework-repo-docs
branch
from
b69857d to
63a334a
Compare
tsloughter
added a commit
that referenced
this pull request
Jan 17, 2016
Rework README and CONTRIBUTING documents
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.
the project: what it is, why use it, how to get started, where to find
more information. It looks less like a reference and more like a brief
overview of rebar3.
be moved to the website
explain how to write tests, how to structure code, and so on.
Fixes #1020