chore(add-files): Added README.md, LICENSE and CHANGELOG.md files #1
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
mpiercy827
reviewed
Jul 17, 2018
LICENSE
Outdated
| @@ -0,0 +1,21 @@ | |||
| MIT License | |||
|
|
|||
| Copyright (c) 2018 Shraddha Sharma | |||
README.md
Outdated
| @@ -1,6 +1,8 @@ | |||
| # Litmus | |||
|
|
|||
| **TODO: Add description** | |||
|  | |||
There was a problem hiding this comment.
This is the badge for lazy_agent, we might want to wait until we have this up on Hex before adding our badge.
README.md
Outdated
| **TODO: Add description** | ||
|  | ||
|
|
||
| Data Schema validation in Elixir |
There was a problem hiding this comment.
how about just Data Validation in Elixir?
|
Can you update the PR title to have an |
shraddha1704
changed the title
mpiercy827
approved these changes
Jul 17, 2018
mgartner
reviewed
Jul 18, 2018
CHANGELOG.md
Outdated
| ## Unreleased | ||
| ### Added | ||
| - Basic ExDoc configuration | ||
| - Markdown documentation (README, LICENSE, CHANGELOG) |
There was a problem hiding this comment.
I think you can leave this out until you release a version. Also, I'd suggest to only include things here that are pertintent to know for users who are upgrading versions. For example, if I'm upgrade from 0.1.0 to 1.0.0, I probably don't care about whether or not the README changed, and I"m mouch more interested in how the interfaced changed and what will break.
mgartner
suggested changes
Jul 18, 2018
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.
What
Why