[do-not-merge]🎨 Add code of conduct references and template #556
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -5,8 +5,9 @@ Standard Base Documentation | |||||||||
| ## Patlet | ||||||||||
|
|
||||||||||
| New contributors to an InnerSource project have a hard time figuring out who | ||||||||||
| maintains the project, what to work on, how to contribute, and how to communicate | ||||||||||
| or collaborate with others. Providing documentation in standard files like | ||||||||||
| `README.md`, `CONTRIBUTING.md`, or `CODE_OF_CONDUCT.md` enables a | ||||||||||
| self service process for new contributors, so that they can find the answers to | ||||||||||
| the most common questions on their own. | ||||||||||
|
|
||||||||||
|
|
@@ -81,6 +82,18 @@ topics: | |||||||||
|
|
||||||||||
|  | ||||||||||
|
|
||||||||||
| ### CODE_OF_CONDUCT.md | ||||||||||
|
|
||||||||||
| Defining a Code of Conduct within an InnerSource project is essential for fostering a welcoming and | ||||||||||
|
There was a problem hiding this comment.
Suggested change
The previous section for the CONTRIBUTING.md contains a qualifier, stating when a separate file makes sense:
I wonder if we could add something similar to the beginning of the CODE_OF_CONDUCT.md section? I think we could use bits and pieces from this comment of yours:
I am leaving a proposal in the suggestion to help you understand the way that I am thinking about this. Feel free to change this entirely :) Also if we could somehow add the "Social Contract" concept somewhere (including the link) that would be great. Maybe it is a useful exercise for a team to do, before they write their CoC? |
||||||||||
| inclusive community environment. It sets clear expectations for behavior and establishes guidelines that | ||||||||||
| promote respectful and collaborative interactions among project contributors. A well-crafted Code of Conduct | ||||||||||
| helps prevent and address issues such as harassment, discrimination, and toxic behavior, ensuring that | ||||||||||
| everyone feels safe and valued within the project. By providing a framework for positive and inclusive | ||||||||||
| participation, a Code of Conduct encourages diverse perspectives, enhances collaboration, and ultimately | ||||||||||
| leads to the development of higher-quality open-source software. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
|
|
||||||||||
|  | ||||||||||
|
|
||||||||||
| There are many of good examples for how to write a `README.md` and what kind | ||||||||||
| of information to include in a `CONTRIBUTING.md` file in various open source projects. | ||||||||||
| Pages like [how to write a readme that rocks](https://m.dotdev.co/how-to-write-a-readme-that-rocks-bc29f279611a), | ||||||||||
|
|
@@ -95,9 +108,14 @@ users and contributors will need. InnerSource projects likely will not cover all | |||||||||
| of those aspects right from the start, the list itself is helpful for | ||||||||||
| inspiration for what one could cover. | ||||||||||
|
|
||||||||||
| The [Contributor Covenant](https://www.contributor-covenant.org/) provides a set of good | ||||||||||
| templates of `CODE_OF_CONDUCT.md`, very common in the Open Source space. It is a good | ||||||||||
| reference to build your own in your InnerSource project. | ||||||||||
|
|
||||||||||
| In addition to that, this pattern comes with two very basic templates to get you | ||||||||||
| started right away: [README-template.md](templates/README-template.md), | ||||||||||
| [CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md), and | ||||||||||
| [CODE_OF_CONDUCT-template.md](templates/CODE_OF_CONDUCT-template.md). | ||||||||||
|
|
||||||||||
| ## Resulting Context | ||||||||||
|
|
||||||||||
|
|
@@ -128,7 +146,9 @@ Provide standard base documentation through a README | |||||||||
|
|
||||||||||
| * [README-template.md](templates/README-template.md) and | ||||||||||
| * [CONTRIBUTING-template.md](templates/CONTRIBUTING-template.md) | ||||||||||
| * [CODE_OF_CONDUCT-template.md](templates/CODE_OF_CONDUCT-template.md) | ||||||||||
|
|
||||||||||
| ## Credits | ||||||||||
|
|
||||||||||
| [Web](https://storyset.com/web), [People](https://storyset.com/people), and | ||||||||||
| [Community](https://storyset.com/community) illustrations by Storyset. | ||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| <!-- | ||
|
There was a problem hiding this comment. Great idea with the variables here. Nice! |
||
| Variables to be replaced: | ||
| - {{ Community-Name }} | ||
| - {{ CommunityMail-Link }} | ||
| --> | ||
|
|
||
| # Code of Conduct | ||
|
There was a problem hiding this comment. You mention that this template is adapted from https://www.contributor-covenant.org/version/2/1/code_of_conduct/. Could you add some context to the major changes you made, so that I can understand why they were made? The changes I spotted:
I am sure I missed other changes that were made :) |
||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, {{ Community-Name }} as | ||
|
There was a problem hiding this comment. Will this sentence read correctly when the placeholder is replaced? I tried this with the example of our own patterns community:
I think it is the "as contributor and maintainer" that is throwing me off a bit. Not quite sure. |
||
| contributor and maintainer pledge to making participation in this project a | ||
| harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
| level of experience, education, socio-economic status, nationality, personal | ||
| appearance, race, religion, or sexual identity and orientation. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic | ||
| address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| {{ Community-Name }} is responsible for clarifying the standards of acceptable | ||
| behavior and is expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| {{ Community-Name }} has the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project e-mail | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting us at {{ CommunityMail-Link }}. | ||
| All complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and appropriate to the circumstances. {{ Community-Name }} is | ||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||
| Further details of specific enforcement policies may be posted separately. | ||
|
|
||
| Anyone who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership. | ||
|
|
||
| ## Attribution | ||
|
|
||
| [](CODE_OF_CONDUCT-template.md) | ||
|
|
||
| This Code of Conduct is adapted from the | ||
| [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, | ||
| available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have an email address that I can use to add you as Editor to this Google Doc?
Then we could add your illustration there, to make it easier to edit it in the future.
Also I might try to change formatting a tiny bit, to make it even more consistent with the other two visuals that we already have. (What I have in mind are coloring and centering the text below the image).