Great tips David, thanks! On Mon, Nov 26, 2018 at 6:32 PM David Blevins <[email protected]> wrote:
> Quick note that emails for PRs should have a description of the work in > the subject line. Here are some examples and why: > > - bad: This is an email about PR #451 > - bad: See PR #451 > - bad: Review PR #451 > - bad: Help needed in PR #451 > > With this style you'll get low participation on the thread as the subject > is hidden. You yourself will curse these emails in six months or a year in > the future when you're looking for that valuable thread you remember, but > your search reveals 10 threads all with basically only a number as the > subject. You'll either click and read all 10 PRs and email threads, or > you'll more likely just give up. Worse, you may read all 10 and not find > what you're looking for. Do your future self a favor and help him/her find > the valuable discussions. > > > - ok: Options pertaining to the configuration of Javamail - PR# 451 > - ok: Fixing issues on failover of JMS messages - PR# 451 > - ok: Documenting deployment of JCA Connectors - PR# 451 > > These are ok, much better than just a number. Subjects are often > truncated. The real "meat" is at the end of the sentence which makes it > the first to go. Not a show-stopper, but can make your life hard when > searching or scanning. > > - best: Javamail configuration options - PR# 451 > - best: JMS Failover issues - PR# 451 > - best: JCA connector deployment - PR# 451 > > Here we flip it. The real subject as at the beginning. The verbs and > generic nouns like "options" come after. When you can pull it off, huge > respect. > > > -- > David Blevins > http://twitter.com/dblevins > http://www.tomitribe.com > >
