{"id":263479,"date":"2017-12-08T07:52:23","date_gmt":"2017-12-08T14:52:23","guid":{"rendered":"http:\/\/css-tricks.com\/?p=263479"},"modified":"2017-12-08T11:09:25","modified_gmt":"2017-12-08T18:09:25","slug":"open-source-etiquette-guidebook","status":"publish","type":"post","link":"https:\/\/css-tricks.com\/open-source-etiquette-guidebook\/","title":{"rendered":"An Open Source Etiquette Guidebook"},"content":{"rendered":"

Open source software is thriving. Large corporations are building on software that rests on open collaboration, enjoying the many benefits of significant community adoption. Free and open source software is amazing for its ability to bring together many people from all over the world, and join their efforts and skills by their interests. <\/p>\n

<\/p>\n

That said, and because we come from so many different backgrounds, it\u2019s worth taking a moment to reflect on how we work together. The manner in which you conduct yourself while working with others can sometimes impact whether your work is merged, whether someone works on your issue, or in some cases, why you might be blocked from participating in the repository in the future. This post was written to guide people as best as possible on how to keep these communications running smoothly. Here\u2019s a bullet point list of etiquette in open source to help you have a more enjoyable time in the community and contribute to making it a better place.<\/p>\n

For the Maintainer<\/h3>\n
\n
Use labels like \u201chelp wanted\u201d or \u201cbeginner friendly\u201d to guide people to issues they can work on if they are new to the project.<\/li>\n
When running benchmarks, show the authors of the framework\/library\/etc the code you\u2019re going to run to benchmark on before running it. Allow them to PR (it\u2019s ok to give a deadline). That way when your benchmark is run you know they have your approval and it\u2019s as fair as possible. This also fixes issues like benchmarking dev instead of prod or some user errors.<\/li>\n
When you ask someone for help or label an issue help wanted and someone PRs, please write a comment explaining why you are closing it if you decide not to merge. It\u2019s disrespectful of their time otherwise, as they were following your call to action. I would even go so far as to say it would be nice to comment on any PR that you close OR merge, to explain why or say thank you, respectively.<\/li>\n
Don\u2019t close a PR from an active contributor and reimplement the same thing yourself. Just\u2026 don\u2019t do this.<\/li>\n
If a fight breaks out on an issue that gets personal, shut it down to core maintainers as soon as possible. Lock the issue and ensure to enforce the code of conduct if necessary.<\/li>\n
Have a code of conduct and make its presence clear. You might consider the contributor covenant<\/a> code of conduct. GitHub also now offers easy code of conduct integration with some base templates.<\/li>\n<\/ul>\n
For the User<\/h3>\n
\n
Saying thank you for the project before making an inquiry about a new feature or filing a bug is usually appreciated.<\/li>\n
When opening an issue, create a small, isolated, simple, reproduction of the issue using an online code editor (like codepen or codesandbox) if possible and a GitHub repository if not. The process may help you discover the underlying issue (or realize that it\u2019s not an issue with the project). It will also make it easier for maintainers to help you resolve the problem.<\/li>\n
When opening an issue, please suggest a solution to the problem. Take a few minutes to do a little digging. This blog post<\/a> has a few suggestions for how to dive into the source code a little. If you\u2019re not sure, explain you\u2019re unsure what to do.<\/li>\n
When opening an issue, if you\u2019re unable to resolve it yourself, please explain that. The expectation is that you resolve the issues you bring up. If someone else does it, that\u2019s a gift they\u2019re giving to you (so you should express the appropriate gratitude in that case).<\/li>\n
Don\u2019t file issues that say things like \u201cis this even maintained anymore?\u201d A comment like this is insulting to the time they have put in, it reads as though the project is not valid anymore just because they needed a break, or were working on something else, or their dad died or they had a kid or any other myriad human reasons for not being at the beck and call of code. It\u2019s totally ok to ask if there\u2019s a roadmap for the future, or to decide based on past commits that it\u2019s not maintained enough for your liking. It\u2019s not ok to be passive aggressive to someone who created something for you for free.<\/li>\n
If someone respectfully declines a PR because, though valid code, it\u2019s not the direction they\u2019d like to take the project, don\u2019t keep commenting on the pull request. At that point, it might be a better idea to fork the project if you feel strongly the need for a feature.<\/li>\n
When you want to submit a really large pull request to a project you\u2019re not a core contributor on, it\u2019s a good idea to ask via an issue if the direction you\u2019d like to go makes sense. This also means you\u2019re more likely to get the pull request merged because you have given them a heads up and communicated the plan. Better yet, break it into smaller pull requests so that it\u2019s not too much to grok at one time.<\/li>\n
Avoid entitlement. The maintainers of the project don\u2019t owe you anything. When you start using the project, it becomes your responsibility to help maintain it. If you don\u2019t like the way the project is being maintained, be respectful when you provide suggestions and offer help to improve the situation. You can always fork the project to work on on your own if you feel very strongly it’s not the direction you would personally take it.<\/li>\n
Before doing anything on a project, familiarize yourself with the contributor guidelines often found in a CONTRIBUTING.md file at the root of the repository. If one does not exist, file an issue to ask if you could help create one.<\/li>\n<\/ul>\n
Final Thoughts<\/h3>\n
The overriding theme of these tips is to be polite, respectful, and kind. The value of open source to our industry is immeasurable. We can make it a better place for everyone by following some simple rules of etiquette. Remember that often maintainers of projects are working on it in their spare time. Also don\u2019t forget that users of projects are sometimes new to the ever-growing software world. We should keep this in mind when communicating and working together. By so doing, we can make the open source community a better place.<\/p>\n","protected":false},"excerpt":{"rendered":"
Open source software is thriving. Large corporations are building on software that rests on open collaboration, enjoying the many benefits […]<\/p>\n","protected":false},"author":250867,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"inline_featured_image":false,"c2c_always_allow_admin_comments":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"_share_on_mastodon":"0","_share_on_mastodon_status":"%title% %permalink%"},"categories":[4],"tags":[1360,1361,885,477],"class_list":["post-263479","post","type-post","status-publish","format-standard","hentry","category-articles","tag-community","tag-contributions","tag-maintenance","tag-open-source"],"acf":{"show_toc":"No"},"share_on_mastodon":{"url":"","error":""},"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack-related-posts":[{"id":315903,"url":"https:\/\/css-tricks.com\/open-prioritization\/","url_meta":{"origin":263479,"position":0},"title":"Open Prioritization","author":"Chris Coyier","date":"July 14, 2020","format":false,"excerpt":"Like Kickstarter, but for Web Platform Features. That's about the quickest way to sum up Open Prioritization from Igalia. Igalia is an independent company that works on browsers. They literally commit to all the different open source browsers to implement (and fix) features that we all use. Now they are\u2026","rel":"","context":"In "Links"","block_context":{"text":"Links","link":"https:\/\/css-tricks.com\/category\/links\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2020\/06\/open-prioritization.png?fit=1200%2C600&ssl=1&resize=350%2C200","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2020\/06\/open-prioritization.png?fit=1200%2C600&ssl=1&resize=350%2C200 1x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2020\/06\/open-prioritization.png?fit=1200%2C600&ssl=1&resize=525%2C300 1.5x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2020\/06\/open-prioritization.png?fit=1200%2C600&ssl=1&resize=700%2C400 2x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2020\/06\/open-prioritization.png?fit=1200%2C600&ssl=1&resize=1050%2C600 3x"},"classes":[]},{"id":299365,"url":"https:\/\/css-tricks.com\/how-building-in-the-open-can-change-our-industry\/","url_meta":{"origin":263479,"position":1},"title":"How Building in the Open Can Change Our Industry","author":"Amina Adewusi","date":"November 21, 2019","format":false,"excerpt":"I have to admit, I'm a developer who hasn't built a website. When I first read Chris's question, I sat in silence for at least a minute. Which technical topic did I want to discuss? A new library, programming language or best practice? Nothing, in particular, came to mind. Is\u2026","rel":"","context":"In "2019 End-of-Year Thoughts"","block_context":{"text":"2019 End-of-Year Thoughts","link":"https:\/\/css-tricks.com\/category\/2019-end-of-year-thoughts\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":360607,"url":"https:\/\/css-tricks.com\/open-source-sustainability\/","url_meta":{"origin":263479,"position":2},"title":"Open Source & Sustainability","author":"Chris Coyier","date":"January 12, 2022","format":false,"excerpt":"It's a god-damned miracle to me that open source is as robust as it is in tech. Consider the options. You could have a job (or be entrepreneurial) with your coding skills and likely be paid quite well. Or, you could write code for free and have strangers yell at\u2026","rel":"","context":"In "Articles"","block_context":{"text":"Articles","link":"https:\/\/css-tricks.com\/category\/articles\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2022\/01\/github-commit-activity.png?fit=1200%2C600&ssl=1&resize=350%2C200","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2022\/01\/github-commit-activity.png?fit=1200%2C600&ssl=1&resize=350%2C200 1x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2022\/01\/github-commit-activity.png?fit=1200%2C600&ssl=1&resize=525%2C300 1.5x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2022\/01\/github-commit-activity.png?fit=1200%2C600&ssl=1&resize=700%2C400 2x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2022\/01\/github-commit-activity.png?fit=1200%2C600&ssl=1&resize=1050%2C600 3x"},"classes":[]},{"id":267969,"url":"https:\/\/css-tricks.com\/a-browser-based-open-source-tool-for-alternative-communication\/","url_meta":{"origin":263479,"position":3},"title":"A Browser-Based, Open Source Tool for Alternative Communication","author":"Amberley Romo","date":"March 14, 2018","format":false,"excerpt":"Have you ever lost your voice? How did you handle that? Perhaps you carried a notebook and pen to scribble notes. Or jotted quick texts on your phone. Have you ever traveled somewhere that you didn't speak or understand the language everyone around you was speaking? How did you order\u2026","rel":"","context":"In "Articles"","block_context":{"text":"Articles","link":"https:\/\/css-tricks.com\/category\/articles\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2018\/03\/cboard.jpg?fit=1200%2C600&ssl=1&resize=350%2C200","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2018\/03\/cboard.jpg?fit=1200%2C600&ssl=1&resize=350%2C200 1x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2018\/03\/cboard.jpg?fit=1200%2C600&ssl=1&resize=525%2C300 1.5x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2018\/03\/cboard.jpg?fit=1200%2C600&ssl=1&resize=700%2C400 2x, https:\/\/i0.wp.com\/css-tricks.com\/wp-content\/uploads\/2018\/03\/cboard.jpg?fit=1200%2C600&ssl=1&resize=1050%2C600 3x"},"classes":[]},{"id":18998,"url":"https:\/\/css-tricks.com\/web-developer-economics-one-off-software-costs\/","url_meta":{"origin":263479,"position":4},"title":"Web Developer Economics: One Off Software Costs","author":"Chris Coyier","date":"October 26, 2012","format":false,"excerpt":"We kicked this little series off talking about monthly service costs, then started a poll about earnings, now let's keep it going and talk about software again. This time, software that you only buy once. Maybe it has paid upgrades once in a while, but those are optional (e.g. Adobe\u2026","rel":"","context":"In "Articles"","block_context":{"text":"Articles","link":"https:\/\/css-tricks.com\/category\/articles\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":7789,"url":"https:\/\/css-tricks.com\/custom-vanilla-forums-work-by-trademark-productions\/","url_meta":{"origin":263479,"position":5},"title":"Custom Vanilla Forums Work by Trademark Productions","author":"Chris Coyier","date":"November 3, 2010","format":false,"excerpt":"I had some custom Vanilla Forums work done by Trademark Productions. This is my thank you to them and how my experience went down.","rel":"","context":"In "Articles"","block_context":{"text":"Articles","link":"https:\/\/css-tricks.com\/category\/articles\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/posts\/263479","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/users\/250867"}],"replies":[{"embeddable":true,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/comments?post=263479"}],"version-history":[{"count":6,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/posts\/263479\/revisions"}],"predecessor-version":[{"id":263600,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/posts\/263479\/revisions\/263600"}],"wp:attachment":[{"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/media?parent=263479"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/categories?post=263479"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/css-tricks.com\/wp-json\/wp\/v2\/tags?post=263479"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}