Documentation improvements #177
Merged
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
dpordomingo
approved these changes
Feb 28, 2018
smacker
reviewed
Feb 28, 2018
README.md
Outdated
| ## Contributing | ||
|
|
||
| [Contributions](https://github.com/src-d/code-annotation/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](CONTRIBUTING.md). | ||
| [Contributions](https://github.com/src-d/code-annotation/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](CONTRIBUTING.md). You have more information on how to deploy it for [development purposes here](CONTRIBUTING.md#Development). |
There was a problem hiding this comment.
@carlosms your English is better than mine. Are you sure deploy is the correct word here? For developers, we give instructions how to run locally not deploy. But I can be wrong.
There was a problem hiding this comment.
how to deploy it for ... -> how to build and run locally for ... ?
There was a problem hiding this comment.
You are right, running locally is more clear. Fixed in 1bde8b9
6 tasks
|
@carlosms now all the feedback seems to be addressed, can you merge? |
|
@dpordomingo I'm waiting because of the conversation on the issue, we may want to add more things to this PR: #67 (comment) |
bzz
approved these changes
Mar 1, 2018
Signed-off-by: Carlos Martín <carlos.martin.sanchez@gmail.com> Add link to contributing.md development Signed-off-by: Carlos Martín <carlos.martin.sanchez@gmail.com> Update readme screenshot Signed-off-by: Carlos Martín <carlos.martin.sanchez@gmail.com> Improve wording for dev: deploy -> run locally Signed-off-by: Carlos Martín <carlos.martin.sanchez@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Based on #170.
The bullets from #67 fixed in this PR are: