Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include a Q&A guide to CONTRIBUTING.md so that would-be contributors can quickly get the information they need #3187

Closed
4 tasks done
jtigger opened this issue Oct 20, 2016 · 6 comments
Assignees

Comments

@jtigger
Copy link

jtigger commented Oct 20, 2016

Take the structure expressed at http://exercism.io/contribute and evolve it into a 2 or 3 step Q&A flow that helps point would-be contributors to the information they need.

An example of that structure is illustrated in this diagram.

Parts to this ticket:

  • update CONTRIBUTION.md to include a visually easy-to-follow flow that ultimately points to existing documentation.
  • where there is low-hanging fruit to slice out commonly referred to topics/how-tos, go a head and do the needful to shape the information in a more modular set of .md files.
  • replace the "Contributing To Exercism" section of the readme to this repo with a link to this contribution page.
  • update the footer at the bottom of the website to point to this contribution page instead of http://exercism.io/contribute

(this is part of a larger effort to overhaul contributor documentation)

@jtigger jtigger changed the title Rework http://exercism.io/contribute to start the triage flow Include a Q&A guide to CONTRIBUTING.md so that would-be contributors can quickly get the information they need Oct 20, 2016
@jtigger jtigger self-assigned this Oct 23, 2016
@machikoyasuda
Copy link

@jendiamond @Taekyoon - What are some troubles you are having with contributing to Exercism right now? What would you have liked to see in the Documentation specifically about testing?

@jtigger
Copy link
Author

jtigger commented Feb 9, 2017

Wahoo, I got caught up in some track-building work and neglected this business. I'm back to finish this story up...

jtigger added a commit that referenced this issue Feb 9, 2017
Part of #3187.  This commit attempts to remove redundancy created by the "new" guide.
jtigger added a commit that referenced this issue Feb 9, 2017
We've put in place a nifty guide as part of #3187.  This change points website users to that guide.
@jtigger
Copy link
Author

jtigger commented Feb 9, 2017

If those PRs are accepted, this particular piece is considered "done".

kytrinyx pushed a commit that referenced this issue Feb 12, 2017
We've put in place a nifty guide as part of #3187.  This change points website users to that guide.
@kytrinyx
Copy link
Member

The PRs are accepted. If this concludes the exercise, would you close this, @jtigger ?

@kytrinyx
Copy link
Member

I'm going to go ahead and close this. @jtigger if there's more to do here, would you open an issue in the docs repo?

@jtigger
Copy link
Author

jtigger commented Apr 4, 2017

Yeah, whoops! Slipped off my radar. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants