added to the README file #254
Closed
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
|
@priya2004k is attempting to deploy a commit to the Listinai Team on Vercel. A member of the Team first needs to authorize it. |
|
The contributing section is typically in contribututing.md, I also requested a PR on this, see #242. |
|
Hey @priya2004k , thanks for this contribution, but on further review, it kind of messes the formatting of README.md too much, and @nevo-david put a lot of effort into that. We're not going to merge this PR this time. Next time, consider raising in issue first to dicuss what changes you think might be necessary before making the changes. |
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 kind of change does this PR introduce?
This PR changes the README file by adding a table of contents, description, purpose, and contribution guidelines section to the file.
eg: Bug fix, feature, docs update, ...
Why was this change needed?
The change was needed to help make the ReadMe file better and to abide by good documentation guidelines.
Please link to related issues when possible.
Other information:
eg: Did you discuss this change with anybody before working on it (not required, but can be a good idea for bigger changes). Any plans for the future, etc?