diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md index b7131168..576b7b4d 100644 --- a/CODE-OF-CONDUCT.md +++ b/CODE-OF-CONDUCT.md @@ -1,6 +1,6 @@ -## Code of Conduct +# Code of Conduct -### Our Pledge +## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our @@ -10,7 +10,7 @@ characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. -### Our Standards +## Our Standards Examples of behavior that contributes to creating a positive environment include: @@ -33,7 +33,7 @@ electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -### Our Responsibilities +## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair @@ -45,7 +45,7 @@ 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 +## Scope This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community @@ -55,7 +55,7 @@ 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 +## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the open source team at @@ -70,7 +70,7 @@ Project maintainers 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 +## Attribution This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8feeb51..3191fcbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ We would love your contributions in the form of: ### Issues -To file a bug or feature request, use [GitHub](https://github.com/apple/containerization/issues/new) +To file a bug or feature request, use [GitHub issues](https://github.com/apple/containerization/issues/new). 🚧 For unexpected behavior or usability limitations, detailed instructions on how to reproduce the issue are appreciated. This will greatly help the priority setting and speed of which maintainers can get to your issue. @@ -27,7 +27,7 @@ To make a pull request, use [GitHub](https://github.com/apple/containerization/c > [!IMPORTANT] > If you plan to make substantial changes or add new features, we encourage you to first discuss them with the wider containerization developer community. -> You can do this by filing a [GitHub issue](https://github.com/apple/containerization/issues/new) +> You can do this by filing a [GitHub issue](https://github.com/apple/containerization/issues/new). > This will save time and increases the chance of your pull request being accepted. We use a "squash and merge" strategy to keep our `main` branch history clean and easy to follow. When your pull request @@ -59,3 +59,7 @@ If you submit a contribution that adds a new file, please add the license header ```bash $ make update-licenses ``` + +## Code of Conduct + +To clarify of what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](/CODE-OF-CONDUCT.MD). \ No newline at end of file diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 6f4e0619..9649a1d3 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -1,5 +1,5 @@ This file contains a list of contributors who have made meaningful changes to this repository. -Please add your name to this file as an optional step in the contribution process for attribution. +Please add your name and GitHub handle to this file as an optional step in the contribution process for attribution. Email is not required. ### Contributors