Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 10.8 KB

DEI.md

File metadata and controls

90 lines (66 loc) · 10.8 KB
Raw

Authoring Your Project's DEI.md File

  1. When creating your own DEI.md file please use the this guide as well as the Template.DEI.md file in your process.

  2. If using a development platform, place the DEI.md file in a public, organizationally available repository, similar to your CODE_OF_CONDUCT.md file

  3. If an organizationally available folder is not available or used, place the DEI.md file in a public community repository

  4. If you have a project website, provide a link to your DEI.md file from the main project navigation

  5. The Sample DEI Project Statement indicates required statements (Required) and sample statements (Sample).

    • (Required:Changes Needed) indicates that the author provide information specific to their project.
    • (Required:No Changes) indicates that the statement should be included with no changes made.
    • (Sample) indicates that the statement contains information that may or may not be useful to the author. Sample statements can be modified and should only be included if they are applicable to your project.

  6. If a statement is labeled (Required:No Changes), do not make any changes to the line. It is important to keep these statements as-is for badging purposes.

  7. Your project must attend to all metrics described below and must include at least one described effort associated with each metric.

  8. Do not use this file to create your DEI.md file. This file is only serves as a guide. Please download and use the DEI.md Template when creating your own DEI.md file.

  9. The CHAOSS DEI.md file is available for further reference.

  10. If you have discovered the Guide.DEI.md or Template.DEI.md file, please note that there is an associated badging process to which your project can receive a DEI Project Badge to recognize your efforts. The badging process is [available here](update link when final).

(Required:No Changes) DEI Project Statement

(Required:Changes Needed) Include Your Project Name/Logo Here

(Required:Changes Needed) Include a description of the scope of the DEI.md file. For example, does this DEI.md file cover one particular repository, a collection of repositories, or an entire organization?

(Required:No Changes) Our project prioritizes and reflects on DEI through a regular review of project policies and performance. This reflection is documented, in part, in the following DEI.md file based on specific CHAOSS DEI metrics.

(Required:No Changes) Project Access

(Required:No Changes) Project access is addressed in our project through various efforts. Through these efforts, we aim to support access for all. Specific efforts in our project include:

  1. (Sample) All virtual meetings are transcribed via the Zoom annotation tool, and members can join via their computer or phone. Video is not required to participate in virtual meetings.
  2. (Sample) Virtual meetings are attentive to global time zones. While most of our meetings occur during times that are most easily accessed by members in North America, South America, Western Europe, and Africa, virtual meetings are also held to support [Project Name] members in Asia-Pacific and Eastern Europe.
  3. (Sample) [Project Name] project maintainers and merge request coaches span global time zones and work asynchronously with contributors across the world.
  4. (Sample) Translation services are provided for all website pages.
  5. (Sample) All areas of [Project Name] are considered open to community contributions. A stated goal of our project is that “everyone can contribute."
  6. (Sample) The [Project Name] SaaS product is conformant with the Voluntary Product Accessibility Template (VPAT 2.4) revised in June 2023 as well as to level AA of the World Wide Web Consortium (W3C) Web Content Accessibility Guidelines 2.1.
  7. (Sample) [Project Name] is developing a unified contributor program that recognizes and rewards non-code contributors, including contributions through events, blog posts, and comments in issues and merge requests.

(Required:No Changes) Communication Transparency

(Required:No Changes) Communication Transparency is addressed in our project through a variety of different efforts. Through these efforts, we aim to support transparency for all. Specific efforts in our project include:

  1. (Sample) All project documentation is publicly available via Google Docs and shared via our [Project Name] community handbook.
  2. (Sample) Appropriate documentation is shared at the start of every working group meeting.
  3. (Sample) Slack channels are regularly reviewed to determine if they should be public or private channels as well as considering if a channel is needed any longer.
  4. (Sample) All virtual meetings are recorded and uploaded to our project YouTube channel.
  5. (Sample) Decisions that impact the project are shared across numerous working groups meetings and associated Slack channels to ensure that as many project members can participate in the process.
  6. (Sample) Any information that cannot be made public (e.g., security and abuse vulnerabilities, financial information, private data) is marked as internal to the project. All of the internal information is listed publicly by name and any other information not marked as internal are available externally to the public.
  7. (Sample) [Project Name] operates using a single source of truth for all community members.
  8. (Sample) [Project Name]'s handbook is public and open to contribution.
  9. (Sample) [Project Name] operates an unfiltered YouTube channel that shares all publicly available meetings, recordings, and community pairing sessions.

(Required:No Changes) Newcomer Experiences

(Required:No Changes) The newcomer experience is addressed in our project through a variety of different efforts. Through these efforts, we aim to support the newcomer experience for all new members. Specific efforts in our project include:

  1. (Sample) Newcomer events are held on a weekly basis in the [Project Name]. These events include newcomer orientation sessions and office hours open to all with an interest.
  2. (Sample) [Project Name] has a dedicated #newcomer channel on Slack where newcomers can join and learn about different ways to connect with the project. In the channel, we have a newcomer bot that provides detailed information on how to engage with the [Project Name]. The bot is available by typing ‘newbie’ in the #newcomer Slack channel.
  3. (Sample) A quick start guide for newcomers is posted on our website and made available through the main website navigation.
  4. (Sample) [Project Name] uses weekly triage reports on first time contributors who are awaiting a response to a merge request. This ensures newcomers always hear back from a real person about their merge request.
  5. (Sample) [Project Name] reviews contributor documentation for inclusivity of newcomers, including improvements to documentation navigation, technical content and jargon, and improving workflow processes for newcomers.
  6. (Sample) [Project Name] automatically applies a 1st contribution label to first-time contributors who open a merge request so they may be better identified and assisted by reviewers and coaches.
  7. (Sample) [Project Name]'s contributor documentation includes a full walkthrough tutorial for newcomers to make their first contribution. This includes setting up the development environment, making code changes, documentation updates and ways to find support.
  8. (Sample) [Project Name] has a dedicated Contributor Success team to facilitate newcomer onboarding, help newcomers find issues, assist newcomers through merge requests and communicate to reviewers on the behalf of contributors to ensure a smoother review experience.
  9. (Sample) [Project Name] offers a community fork which helps newcomers collaborate with other contributors under a shared fork. This means newcomers do not have to maintain and update a personal fork.
  10. (Sample) [Project Name] tracks metrics for new contributors with the goal of increasing total contributors to the project and helping convert new contributors into returning contributors.

(Required:No Changes) Inclusive Leadership

(Required:No Changes) Inclusive leadership is addressed in our project through a variety of different efforts. Through these efforts, we aim to support leadership opportunities for project members with an interest. Specific efforts in our project include:

  1. (Sample) Our [Project Name] governance document is reviewed and affirmed on a yearly basis to identify and articulate roles within the project that help guide the strategic direction of the project.
  2. (Sample) Global chapters of our project are led by people from those regions. Chapter leads help set the strategic direction of the [Project Name] as best suited in different global settings.
  3. (Sample) Working group meetings provide the opportunity to be led by different people at each meeting. While each working group has identified ‘chairs’, leading a meeting provides an opportunity to lead for all members.
  4. (Sample) Our projects ensures a diverse candidate slate and interview panel when selecting new maintainers.
  5. (Sample) All of our project maintainers have completed neurodiversity and other DEI training.
  6. (Sample) One or more of our project maintainers are a member of a working group related to a DEI initiative.
  7. (Sample) One or more of our project maintainers participate in DEI group meetings or events.

(Required:No Changes) We recognize that the inclusion of the DEI.md file and the provided reflection on the specific DEI metrics does not ensure community safety nor community inclusiveness. The inclusion of the DEI.md file signals that we, as a project, are committed to centering DEI in our project and regularly reviewing and reflecting on our project DEI practices.

(Required:Changes Needed) If you do not feel that the DEI.md file appropriately addresses concerns you have about community safety and inclusiveness, please let us know. You can do this by reporting your concerns to our Code of Conduct team (provide a link to your code of conduct team) to raise concerns you have. (If there is no Code of Conduct team, please replace the last sentence with an appropriate reporting process).

(Required:Changes Needed) Last Reviewed: [Enter Date]