Page MenuHomePhabricator

README update - rely on bug reporting doc and add section about community chat
ClosedPublic

Authored by btrahan on Feb 5 2015, 5:10 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Dec 27, 11:47 PM
Unknown Object (File)
Fri, Dec 20, 6:00 PM
Unknown Object (File)
Fri, Dec 13, 7:20 PM
Unknown Object (File)
Fri, Dec 13, 6:56 PM
Unknown Object (File)
Sun, Dec 8, 8:04 AM
Unknown Object (File)
Sat, Dec 7, 3:47 PM
Unknown Object (File)
Nov 29 2024, 6:21 AM
Unknown Object (File)
Nov 26 2024, 1:42 PM
Subscribers

Details

Summary

Saw D11693 and I thought these changes on top might make the README even better? Open for discussion. I like our bug reporting doc a lot so I don't mind funneling users through it and not mentioning the bug reporting link directly in the readme. This notably forces github users to read a bit before they report issues to us for the first time. That said, I think the community chat can be really helpful at no cost to us so why not upsell it? This could fail if people start asking for say epriestley directly and / or the overall chatter is time consuming, but seemed worth tossing out at least.

Test Plan

read the text, asking opinions of cohorts

Diff Detail

Repository
rP Phabricator
Branch
bugreport
Lint
Lint Warnings
SeverityLocationCodeMessage
WarningREADME.md:22TXT3Line Too Long
WarningREADME.md:30TXT3Line Too Long
Unit
No Test Coverage
Build Status
Buildable 4353
Build 4366: [Placeholder Plan] Wait for 30 Seconds

Event Timeline

btrahan retitled this revision from to README update - rely on bug reporting doc and add section about community chat.
btrahan updated this object.
btrahan edited the test plan for this revision. (Show Details)
btrahan added reviewers: epriestley, chad.
epriestley edited edge metadata.

Elsewhere, I spell out IRC channel (#phabricator on FreeNode) because the link doesn't give users enough information to connect if the irc:// protocol does not work on their machine. In particular, they have to take some extra steps to figure out how to connect with a web client. But I don't know that this is really an issue.

This revision is now accepted and ready to land.Feb 5 2015, 5:14 PM

enough information

(I mean, technically it has all the information, but if you don't really know what IRC is and you don't have a client installed you have less to go on when Googling or whatever.)

btrahan edited edge metadata.

spell out IRC Channel (Phabricator on FreeNode)

This revision was automatically updated to reflect the committed changes.