CodeTriage icon indicating copy to clipboard operation
CodeTriage copied to clipboard

Published 20 hours ago • verified publisher icon codetriage

Introduce help page

Open cheerfulstoic opened this issue 8 years ago • 9 comments

I was having trouble finding the original instructions that I received on how to triage. This pull request:

  • Makes a new section with those instructions
  • Uses the same partial to render the instructions in the intro E-Mail
  • Links to the help page from the daily E-Mails

I tried making the "_guide_to_triage" partial be a markdown file so that it could be both HTML and plain text like in the E-Mail templates, but I wasn't sure how to do that

This should address #337

cheerfulstoic avatar Sep 18 '15 10:09 cheerfulstoic

Does this seem good? Somebody on holiday? ;)

cheerfulstoic avatar Oct 12 '15 02:10 cheerfulstoic

My github notifications were all going to trash. Sorry :(

schneems avatar Oct 12 '15 14:10 schneems

No problem! I know it's not easy running an OSS project ;)

cheerfulstoic avatar Oct 12 '15 15:10 cheerfulstoic

By the way, so far I've been using this project just on my own projects which have a decent backlog of issues. Our previous strategy was going through issues every once in a while to clean up. It's great having issues sent to me daily so that I can work through them at a manageable pace. You might want to market it as a tool for that as well.

cheerfulstoic avatar Nov 02 '15 02:11 cheerfulstoic

Thanks, that's good to hear. I've had some features requested to make this better for projects you own. For example a "week in review" of all issues opened and not closed this week. Also probably some kind of either a stale issue notifier or bot.

Sorry about the delay on getting this merged in, we went through a whirlwind of changes. When I got this patch to apply cleanly it needed some styles. Then I wasn't sure about some stuff. Right now it sits in a branch on my local machine. It will probably be a bit more time before i'll be able to come back to this.

schneems avatar Nov 02 '15 22:11 schneems

You might want to market it as a tool for that as well.

I forgot to ask. Do you have any ideas how individual project owners might want to be targeted? What would a good way to reach out be?

schneems avatar Nov 02 '15 22:11 schneems

No problem, take your time ;)

As to reaching out to project owners, my main thought was just listing it as another use-case on the homepage (which looks great, BTW). Perhaps when people sign-in with GitHub you could scan their repos and point out ones with a lot of issues (perhaps prioritized by how recently they've been updated)

cheerfulstoic avatar Nov 03 '15 03:11 cheerfulstoic

@cheerfulstoic Can you rebase this? I'd like to see it live on a review app.

nateberkopec avatar May 27 '17 23:05 nateberkopec

Sorry, I'm insanely busy lately, but the changes should be pretty easy to copy into master. I don't care if they're your commits ;)

cheerfulstoic avatar May 28 '17 22:05 cheerfulstoic