Trim down content in CONTRIBUTING.md, move detailed content to Wiki. #190
Conversation
| 0. Submit a [pull request](https://github.com/zen-audio-player/zen-audio-player.github.io/pulls) - Travis CI will run tests to make sure nothing broke. | ||
| 0. In case the following occurs, skip to **[Syncing](#syncing)** below | ||
| 0. Submit a [pull request](https://github.com/zen-audio-player/zen-audio-player.github.io/pulls) - Travis CI will run tests to make sure nothing broke. Once you have committed your changes locally and pushed them to your fork of the repo, a banner with a **Compare & pull request** button should appear on the main Zen Audio Player repo page to submit a pull request. | ||
|  |
There was a problem hiding this comment.
This may be a broken link, I don't think you need the leading / either way
There was a problem hiding this comment.
Are you referring to the pull request link? It's working for me.
And are you saying github.com/zen-audio-player/zen-audio-player.github.io/pulls is preferable over https://github.com/zen-audio-player/zen-audio-player.github.io/pulls?
There was a problem hiding this comment.
I think /.github/submit_pr.png might not need the first /, not sure if it will work with it there
There was a problem hiding this comment.
Ah! I was looking at the wrong link, that makes sense.
There was a problem hiding this comment.
Now that I took a closer look, the link for that other screenshot: /.github/outofsync.png has the same leading backslash and seems to link properly. Would you still recommend removing them (from both links)?
There was a problem hiding this comment.
Yeah, when I see a path beginning with / I think of the root of a *nix filesystem... which is probably not what we want here even if the leading / "just works" 😆
|
Thanks @josectello, we should do the same for the PR & issue templates. I fear they're too long to actually be used. For the wiki, can you create another page and move your additions there? The "Contribution Flow" page was meant to only be that first section I added. The actual changes to |
|
@shakeelmohamed I'll get on that today. Thanks! |
|
@shakeelmohamed You're probably very busy as well, but I was wondering if you saw my line comment about link above. |
Updated README, closes #182 Browser compatibility matrix in progress, referencing #48 Added icons, referencing #48 Modified icons, referencing #48 Browser compatibility matrix done, referencing #48 Resized images, referencing #48 Fixed, referencing #48 Fixed 1, referencing #48 Fixed 2, referencing #48 Fix: pause video when we get an error This needs to happen since we hide the controls. Update primer (#189) Signed-off-by: Matthew Brener <[email protected]> Update primer Signed-off-by: Matthew Brener <[email protected]>
|
Looks great, thanks @josectello! For the record, leave a comment after you've made changes otherwise I won't get a notification 😴 |
Moved Syncing and other content to Contributions page of Wiki. Added a screenshot for submitting a PR (banner that appears on GitHub).
Potentially a few more bullets that I think may be able to added into
CONTRIBUTING.mdwithout bloating the file too much.Some ideas for the sections in the Contributions page of the Wiki:
This (potentially) closes #49. But probably not, since this still needs feedback!