Slava Akhmechet (cofounder of RethinkDB) has a great article on Github issue etiquette. These etiquette guidelines are also just good communication principles in general. The RethinkDB team’s communication on GitHub, IRC, Email, and Twitter are great examples of what this looks like, and I always have a good feeling after communicating with them.
The high level points are below, read the article for the full details and examples.
- EG0. Acknowledge receipt
- EG1. Notify when you start work
- EG2. Summarize the state of the issue
- EG3. Give periodic status updates
- EG3-a. Inform everyone if you slip
- EG3-b. Inform everyone if you’re on track
- EG4. Keep internal communication explicit
- EG5. Make responsibility handoffs clear
- EG6. Notify on development completion
- EG7. Notify on fix availability
- EG8. Always use friendly tone
- EG9. Watch grammar and legibility
- EG10. Talk to users on their terms