Please dont make contributors hunt for instructions #144
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
|
FWIW to me .travis,yml is the first place to look at when trying to understand how to build & test a project, given that
What is the first place you look at? I'm interested as I should probably update some of my projects accordingly |
|
That's cool if you've heard of Travis and know think to look at the config file. 👍🏼 If they switch away from Travis to some other thing are you gonna know where that config file lives too? |
localheinz
reviewed
Nov 30, 2017
README.md
Outdated
| @@ -91,10 +91,12 @@ API-Flow is one of the main components of [Console.REST](https://github.com/luck | |||
|
|
|||
| ## Contributing | |||
|
|
|||
| PRs are welcomed! | |||
| Read [CONTRIBUTING.md][] for more tips on testing and contributing. | |||
There was a problem hiding this comment.
How about adding a link here, @philsturgeon?
Or is this equivalent with [CONTRIBUTING.md](CONTRIBUTING.md)?
There was a problem hiding this comment.
Fixed! Thanks, I was using some random syntax that clearly isn't GFM
localheinz
reviewed
Nov 30, 2017
| @@ -91,10 +91,12 @@ API-Flow is one of the main components of [Console.REST](https://github.com/luck | |||
|
|
|||
| ## Contributing | |||
|
|
|||
| PRs are welcomed! | |||
| Read [CONTRIBUTING.md](CONTRIBUTING.md) for more tips on testing and contributing. | |||
philsturgeon
force-pushed
the
please-dont-make-contributors-hunt
branch
2 times, most recently
from
e9995f8
to
0cca354
Compare
added 2 commits
December 5, 2017 13:15
A few forks were updating these links and causing conflicts, so lets just use local links :D
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.
Nice easy tips for contributors getting started, who might not know where to look otherwise.