Improve documentation for README and CONTRIBUTING files #3
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
terryyylim
commented
May 27, 2022
terryyylim
requested review from
krithika369 and
leonlnj
and removed request for
eric-lidong and
krithika369
leonlnj
reviewed
Jun 1, 2022
|
|
||
| ## XP Management/Treatment Service using Go | ||
|
|
||
| Both Management & Treatment services are written using Go, and the following describes how to setup your development environment. |
Contributor
There was a problem hiding this comment.
I would think that setup related steps should be in readme instead of contributing.md
Contributor
Author
There was a problem hiding this comment.
Typically, people who want to contribute to the project would look into CONTRIBUTING.md to figure out how they can do so and what steps they need to do to get started. I think it makes sense to leave it here.
README.md would make sense for USERS who want to get started quickly, for eg. if we have a Python SDK, how to get started using easily.
leonlnj
approved these changes
Jun 1, 2022
Contributor
leonlnj
left a comment
leonlnj
left a comment
There was a problem hiding this comment.
LGTM, i think setup related are usually in the readme (like how-to guide)
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 this PR does / why we need it:
This PR improves documentation for README and CONTRIBUTING, as well as adds a template for describing the PR.
Which issue(s) this PR fixes:
NONE