|
| 1 | +<!--- |
| 2 | +The DEI.md file was originally created in the CHAOSS project. This comment provides attribution of that work as defined under the MIT license |
| 3 | +--> |
| 4 | + |
1 | 5 | # Authoring Your Project's DEI.md File
|
2 | 6 |
|
3 |
| -1. If using a development platform, place the DEI.md file in a public, organizationally available repository, similar to your CODE_OF_CONDUCT.md file |
4 |
| -2. If an organizationally availble folder is not available or used, place the DEI.md file in a public community repository |
5 |
| -3. If you have a project website, provide a link to your DEI.md file from the main project navigation |
6 |
| -4. The Sample DEI Project Statement indicates required statements (Required) and sample statements (Sample). |
| 7 | +1. When creating your own DEI.md file please use the this guide as well as the [Template.DEI.md](https://github.com/AllInOpenSource/ProjectBadging/blob/main/Template.DEI.md) file in your process. |
| 8 | +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 |
| 9 | +3. If an organizationally available folder is not available or used, place the DEI.md file in a public community repository |
| 10 | +4. If you have a project website, provide a link to your DEI.md file from the main project navigation |
| 11 | +5. The Sample DEI Project Statement indicates required statements (Required) and sample statements (Sample). |
7 | 12 | - (__Required:Changes Needed__) indicates that the author provide information specific to their project.
|
8 | 13 | - (__Required:No Changes__) indicates that the statement should be included with no changes made.
|
9 | 14 | - (__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.
|
10 | 15 |
|
11 |
| -5. Your project must attend to all metrics described below and must include at least one described effort associated with each metric. |
12 |
| -6. Always replace [Project Name] with the name of your project. |
13 |
| - |
14 |
| -7. 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](https://github.com/AllInOpenSource/ProjectBadging/blob/main/Template.DEI.md) when creating your own DEI.md file. |
| 16 | +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. |
| 17 | +7. Your project must attend to all metrics described below and must include at least one described effort associated with each metric. |
| 18 | +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](https://github.com/AllInOpenSource/ProjectBadging/blob/main/Template.DEI.md) when creating your own DEI.md file. |
| 19 | +9. The [CHAOSS DEI.md](https://github.com/chaoss/community/blob/main/DEI.md) file is available for further reference. |
| 20 | +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). |
15 | 21 |
|
16 | 22 | ***
|
17 | 23 |
|
|
21 | 27 |
|
22 | 28 | (__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?
|
23 | 29 |
|
24 |
| -(__Required:No Changes__) [Project Name] 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](https://chaoss.community) DEI metrics. |
| 30 | +(__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](https://chaoss.community) DEI metrics. |
25 | 31 |
|
26 | 32 | ### (Required:No Changes) [Project Access](https://chaoss.community/?p=4953)
|
27 |
| -(__Required:No Changes__) Project access is addressed in the [Project Name] through various efforts. Through these efforts, we aim to support access for all. Specific efforts in our project include: |
| 33 | +(__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: |
28 | 34 | 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.
|
29 | 35 | 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.
|
30 | 36 | 3. (__Sample__) [Project Name] project maintainers and merge request coaches span global time zones and work asynchronously with contributors across the world.
|
|
34 | 40 | 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.
|
35 | 41 |
|
36 | 42 | ### (Required:No Changes) [Communication Transparency](https://chaoss.community/?p=4957)
|
37 |
| -(__Required:No Changes__) Communication Transparency is addressed in the [Project Name] through a variety of different efforts. Through these efforts, we aim to support transparency for all. Specific efforts in our project include: |
| 43 | +(__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: |
38 | 44 | 1. (__Sample__) All project documentation is publicly available via Google Docs and shared via our [Project Name] community handbook.
|
39 | 45 | 2. (__Sample__) Appropriate documentation is shared at the start of every working group meeting.
|
40 | 46 | 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.
|
|
46 | 52 | 9. (__Sample__) [Project Name] operates an unfiltered YouTube channel that shares all publicly available meetings, recordings, and community pairing sessions.
|
47 | 53 |
|
48 | 54 | ### (Required:No Changes) [Newcomer Experiences](https://chaoss.community/?p=4891)
|
49 |
| -(__Required:No Changes__) The newcomer experience is addressed in the [Project Name] 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: |
| 55 | +(__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: |
50 | 56 | 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.
|
51 | 57 | 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.
|
52 | 58 | 3. (__Sample__) A quick start guide for newcomers is posted on our website and made available through the main website navigation.
|
|
59 | 65 | 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.
|
60 | 66 |
|
61 | 67 | ### (Required:No Changes) [Inclusive Leadership](https://chaoss.community/?p=3522)
|
62 |
| -(__Required:No Changes__) Inclusive leadership is addressed in the [Project Name] 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: |
| 68 | +(__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: |
63 | 69 | 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.
|
64 | 70 | 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.
|
65 | 71 | 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.
|
|
70 | 76 |
|
71 | 77 | (__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.
|
72 | 78 |
|
73 |
| -(__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 in the [Project Name]. You can do this by checking out our Code of Conduct (provide a link to your code of conduct) to raise concerns you have with the Code of Conduct team. |
| 79 | +(__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). |
74 | 80 |
|
75 | 81 | (__Required:Changes Needed__) Last Reviewed: [Enter Date]
|
0 commit comments