Code of Conduct Toolkit for Open Source Communities
Gomathi Anandan
Posted on May 10, 2024
This toolkit provides step-by-step guidance and useful information to anyone planning to implement a code of conduct for an Open Source project or community. It also offers best practice recommendations and helpful examples.
Introduction
A code of conduct is a set of guidelines that states the norms and expected behavior of a community's members. Establishing and following a code of conduct will likely help create a positive and inclusive environment, enhance a community's reputation, increase psychological safety for members, and empower maintainers to address conflicts and unproductive behavior proactively. Proactively introducing such codes is also far more straightforward and has a lower cost than later realizing one was needed.
Primer
Here are the suggested steps for rolling out a code of conduct:
Step 1: Assess the current state
- Review your Open Source project or community to see if it follows an existing code or derives from another larger project/community’s code of conduct.
- Establish a group of stakeholders to assess the needs of your community.
- Assess if the current code satisfies the needs of your community.
Step 2: Review existing resources and examples
A good place to start is the Contributor Covenant, licensed CC BY 4.0. Several Open Source communities use this as a starting point for their codes of conduct.
The following projects are good examples of comprehensive codes of conduct, supporting documentation, and policies: the Django project, Drupal, LLVM, and the Fedora project.
Step 3: Identify the needs and challenges of your project
- After reviewing the resources and examples, discuss the best fit for your community, the level of depth of processes, training for code of conduct committee members, and how you will address community adoption (if applicable).
Step 4: Draft the code of conduct and policies
Draft the code of conduct, supporting documentation, and policies that will suit your community, referencing the above resources and examples with appropriate attribution.
Apart from the actual code itself, your policies should provide the following details:
- Code of Conduct Committee: Identifies the committee members, provides information about how to contact them, outlines their responsibilities, provides guidelines for onboarding and offboarding committee members, and outlines the committee's responsibilities.
- Reporting Guide: This guide provides instructions on reporting an incident, identifies the next steps after the incident is reported, and details confidentiality policies.
- Response Guide: This document establishes how the committee will respond to the report and details potential resolutions and policies for handling conflicts of interest.
- Frequently asked questions: Identify common questions your community may have about the code of conduct and policies and answer them proactively.
- Transparency reports: Publishes updates on open, ongoing, and resolved reports handled by the committee periodically. Your code of conduct policy should define how frequently the committee will publish these reports.
Step 5: Socialize the proposal to roll out a code of conduct and garner support from the community
- Some community members may have reservations about an explicit code of conduct. Socialize establishing a code of conduct by discussing the proposal at a conference with a large community presence or proposing it on your community mailing list.
- If your community needs a governing body, such as community stewards or steering committee, to sign off on a new process rollout, share your proposal and the draft policy documents with them. Work with them individually (if needed) to understand and address questions or concerns. Incorporate feedback from the governing members.
- Share the draft code of conduct policy documents for review with key stakeholders such as the community stewards/steering committee and the community itself. You may publish the documents on the community webpage in “Draft” mode.
- Define a specific review period and invite the community members to offer feedback and raise questions. Identify next steps at the end of the review period.
- Incorporate any feedback from the community in your code of conduct or policy documents.
Step 6: Recruit code of conduct committee members
- Contact diverse community members to serve on the code of conduct committee.
- Explain the minimum commitment term to serve on the committee, responsibilities, and onboarding/offboarding processes.
- Some communities may need leadership's approval (ex, steering committee) before accepting individuals to serve on the code of conduct committee.
- Delegate further recruiting to accepted committee members.
Step 7: Formally adopt the code of conduct and make an announcement
- After the review period, publish the code of conduct and supporting documentation on the community webpage. If you have already published the draft documents on the community site, remove the “Draft” status.
- Announce the official adoption of the code of conduct and related policies on the mailing list.
Step 8: Meet regularly to maintain the code
- Code of conduct committee members meet periodically (ideally once a quarter) to review the incident reports and feedback regarding the code and/or policies and publish transparency reports.
Best practices
- Be sure to provide the required attribution when referencing or deriving information from other projects or communities.
- Establish clear confidentiality and conflict of interest terms to gain trust and acceptance of the code.
- Keep it simple. Make iterative adjustments to your code and policies based on feedback from your community.
- Terminology: Several communities have used similar terminologies for their codes and incident management. Here is a list of basic terms:
- incident
- report
- reporter
- reported person
- incident responder
- risk
- impact
- response
- Training is highly recommended for code of conduct committee members. If possible, choose a vendor with an Open Source specialized background and experience working with Codes of Conduct and enforcement.
- The code of conduct committee should have more than four members in case existing members cannot perform their responsibilities due to conflicts of interest or other reasons. Ideally, there should be six or more members.
- Continue recruiting committee members or seek out volunteers during the feedback collection process.
- Encourage participation and volunteering from community leaders to join the code of conduct committee.
- Ensure the workload is shared equally among all code of conduct committee members. Assign a chair for the committee if it suits the needs of your community.
- Provide access to a legal team (where possible) that the code of conduct committee can consult as relevant questions arise.
- Resources: There is an abundance of resources available online. Here are a few helpful ones:
- Mozilla's process
- Opensource.com Code of Conduct Guide
- Otter Tech Code of Conduct workshop
- Communication templates
- Documentation examples: Elastic and Python Software Foundation
Conclusion
Thousands of Open-Source projects have adopted codes of conduct over the last few years. Codes of Conduct contribute to creating safe, welcoming, and inclusive communities.
Posted on May 10, 2024
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.