diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index fd109e0..3b258f0 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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. +nationality, personal appearance, race, religion, or sexual identity and +orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community +- Focusing on what is best not just for us as individuals, but for the overall + community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -60,8 +60,8 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -thomas_rainbowfish@icloud.com. -All complaints will be reviewed and investigated promptly and fairly. +thomas_rainbowfish@icloud.com. All complaints will be reviewed and investigated +promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. @@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested. ### 2. Warning -**Community Impact**: A violation through a single incident or series -of actions. +**Community Impact**: A violation through a single incident or series of +actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. +like social media. Violating these terms may lead to a temporary or permanent +ban. ### 3. Temporary Ban @@ -106,11 +106,11 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -**Consequence**: A permanent ban from any sort of public interaction within -the community. +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution @@ -118,7 +118,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -Community Impact Guidelines were inspired by [Mozilla's code of conduct +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c36fd52..65544d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,54 +5,54 @@ Welcome! We are glad that you want to contribute to our project! 💖 As you get started, you are in the best position to give us feedback on areas of our project that we need help with including: -* Problems found during setting up a new developer environment -* Gaps in our Quickstart Guide or documentation -* Bugs in our automation scripts +- Problems found during setting up a new developer environment +- Gaps in our Quickstart Guide or documentation +- Bugs in our automation scripts If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know! ## Ways to Contribute - We welcome many different types of contributions including: -* New features -* Builds, CI/CD -* Bug fixes -* Documentation -* Issue Triage -* Answering questions on Slack/Mailing List -* Web design -* Communications / Social Media / Blog Posts -* Release management +- New features +- Builds, CI/CD +- Bug fixes +- Documentation +- Issue Triage +- Answering questions on Slack/Mailing List +- Web design +- Communications / Social Media / Blog Posts +- Release management ## Find an Issue [Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#find-an-issue) We have good first issues for new contributors and help wanted issues suitable -for any contributor. `good first issue` has extra information to -help you make your first contribution. `help wanted` are issues -suitable for someone who isn't a core maintainer and is good to move onto after -your first pull request. +for any contributor. `good first issue` has extra information to help you make +your first contribution. `help wanted` are issues suitable for someone who isn't +a core maintainer and is good to move onto after your first pull request. Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you -don’t know where to start or can't find a suitable issue, you can file a feature request yourself! -Once you see an issue that you'd like to work on, please post a comment saying -that you want to work on it. Something like "I want to work on this" is fine. - +don’t know where to start or can't find a suitable issue, you can file a feature +request yourself! Once you see an issue that you'd like to work on, please post +a comment saying that you want to work on it. Something like "I want to work on +this" is fine. ## Sign Your Commits ### DCO + Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to -our project's repositories. The [Developer Certificate of Origin -(DCO)](https://probot.github.io/apps/dco/) is a way to certify that you wrote and -have the right to contribute the code you are submitting to the project. +our project's repositories. The +[Developer Certificate of Origin (DCO)](https://probot.github.io/apps/dco/) is a +way to certify that you wrote and have the right to contribute the code you are +submitting to the project. You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit. @@ -66,6 +66,6 @@ Git has a `-s` command line option to do this automatically: git commit -s -m 'This is my commit message' If you forgot to do this and have not yet pushed your changes to the remote -repository, you can amend your commit with the sign-off by running +repository, you can amend your commit with the sign-off by running - git commit --amend -s + git commit --amend -s