Seriously, [documentation] is mega-important. The documentation so far has been great and has been a killer feature of Babel. There are sections that could certainly use some work and even the addition of a paragraph here or there is extremely appreciated.
– Sebastian McKenzie
– even fixing typos and dead links –
– even compressing images –
– e.g. outdated browser workarounds –
Are people friendly in the issues, discussion forum, and chat
Do pull requests get reviewed?
Do maintainers thank people for their contributions?
Get notified of all conversations
If you go to an issue tracker and things seem confusing, it’s not just you. These tools require a lot of implicit knowledge, but people can help you navigate it and you can ask them questions.
Maintainers are busy persons who spent a lot of their spare time to create and improve software you are using for free
💚 “X doesn’t happen when I do Y”
❌ “X is broken! Please fix it.”
💚 “I’m not sure how to implement X. I checked the help docs and didn’t find any mentions.”
❌ “How do I X?”
Do your homework beforehand
💚 “I’d like to write an API tutorial.”
❌ “I was driving down the highway the other day and stopped for gas, and then I had this amazing idea for something we should be doing, but before I explain that, let me show you …“
Keep requests short and direct
💚 “Thanks for looking into this error. I followed your suggestions. Here’s the output.”
❌ “Why can’t you fix my problem? Isn’t this your project?”
It’s okay to ask questions (but be patient!)
💚 “I’m disappointed you can’t support my use case, but as you’ve explained it only affects a minor portion of users, I understand why. Thanks for listening.”
❌ “Why won’t you support my use case? This is unacceptable!”
Respect community decisions
See resources on the last slide
A pull request doesn’t have to represent finished work.
It’s usually better to open a pull request early on, so others can watch or give feedback on your progress.
Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.