Skip to content

Commit

Permalink
chore: reflow markdown (#862)
Browse files Browse the repository at this point in the history 
Linting with Reflow Markdown.

Signed-off-by: Ryan Johnson <[email protected]>
  • Loading branch information
@tenthirtyam
tenthirtyam committed Mar 29, 2024
1 parent 295adfd commit 3b5302c
Show file tree
Hide file tree
Showing 11 changed files with 270 additions and 161 deletions.
66 changes: 48 additions & 18 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

## Our Pledge

We as members, contributors, and leaders pledge to make participation in the project and 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.
We as members, contributors, and leaders pledge to make participation in the project and 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.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
healthy community.

## Our Standards

Expand All @@ -14,58 +18,82 @@ Examples of behavior that contributes to a positive environment for our communit
- 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
- 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

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
- 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

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
and will take appropriate and fair corrective action in response to any behavior that they deem
inappropriate, threatening, offensive, or harmful.

Community leaders have 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, and will communicate reasons for moderation decisions when appropriate.
Community leaders have 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, and
will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
This Code of Conduct applies within all community spaces, and also applies when an individual is
officially representing the community in public spaces. Examples of representing our community
include using an official email address, posting via an official social media account, or acting as
an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at [opensource@broadcom][opensource@broadcom]. 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.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community leaders will follow these Community Impact Guidelines in determining the consequences for
any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
**Consequence**: A private, written warning from community leaders, providing clarity around the
nature of the violation and an explanation of why the behavior was inappropriate. A public apology
may be requested.

### 2. Warning

**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.
**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.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Community Impact**: A serious violation of community standards, including sustained inappropriate
behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
**Consequence**: A temporary ban from any sort of interaction or public communication with the
community for a specified period of time. No public or private interaction with the people involved,
including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
period. 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 individual, or aggression toward or disparagement of classes of individuals.
**Community Impact**: Demonstrating a pattern of violation of community 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.

Expand All @@ -75,8 +103,10 @@ This Code of Conduct is adapted from the [Contributor Covenant][contributor-cove

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the [FAQ][contributor-covenant-faq]
and its [translations][contributor-covenant-translations].

[contributor-covenant]: https://www.contributor-covenant.org
[contributor-covenant-faq]: https://www.contributor-covenant.org/faq
[contributor-covenant-translations]: https://www.contributor-covenant.org/translations

For answers to common questions about this code of conduct, see the [FAQ][contributor-covenant-faq] and its [translations][contributor-covenant-translations].
[opensource@broadcom]: [email protected]
103 changes: 56 additions & 47 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,57 +1,59 @@
# Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or
additional documentation, we greatly value feedback and contributions from our community.
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature,
correction, or additional documentation, we greatly value feedback and contributions from our
community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.
Please read through this document before submitting any issues or pull requests to ensure we have
all the necessary information to effectively respond to your bug report or contribution.

## Reporting Bugs, Features, and Enhancements
## Reporting Bugs and Suggesting Enhancements

We welcome you to use the GitHub issue tracker to report bugs or suggest features and enhancements.
We welcome you to use the [GitHub issues][gh-issues] to report bugs or suggest enhancements.

When filing an issue, please check existing open, or recently closed, issues to make sure someone else hasn't already
reported the issue.
When filing an issue, please check existing open, or recently closed, issues to make sure someone
else hasn't already reported.

Please try to include as much information as you can. Details like these are incredibly useful:
Please try to include as much information as you can using the issue fo. Details like these are
incredibly useful:

- A reproducible test case or series of steps.
- Any modifications you've made relevant to the bug.
- Anything unusual about your environment or deployment.

## Contributing via Pull Requests

Contributions via pull requests are appreciated. Before sending us a pull request, please ensure that:
Contributions using pull requests are appreciated. Before sending us a pull request, please ensure
that:

1. You [open a discussion](https://github.com/vmware-samples/packer-examples-for-vsphere/discussions) to discuss any significant work with the maintainer(s).
1. You open an issue and link your pull request to the issue for context.
1. You are working against the latest source on the `develop` branch.
1. You check existing open, and recently merged, pull requests to make sure someone else hasn't already addressed
the problem.
1. You [open a discussion][gh-discussions] to discuss any significant work with the maintainer(s).
2. You [open an issue][gh-issues] and link your pull request to the issue for context.
3. You are working against the latest source on the `develop` branch.
4. You check existing open, and recently merged, pull requests to make sure someone else hasn't
already addressed the problem.

To send us a pull request, please:
To open a pull request, please:

1. Fork the repository.
1. Modify the source; please focus on the **specific** change you are contributing.
1. Ensure local tests pass.
1. Updated the documentation, if required.
1. Commit to your fork [using a clear commit messages](http:https://chris.beams.io/posts/git-commit/). We ask you to
lease use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
1. Send us a pull request, answering any default questions in the pull request.
1. Pay attention to any automated failures reported in the pull request, and stay involved in the conversation.
2. Modify the source; please focus on the **specific** change you are contributing.
3. Ensure local tests pass.
4. Updated the documentation, if required.
5. Commit to your fork [using a clear commit messages][git-commit]. Please use [Conventional Commits][conventional-commits].
6. Open a pull request, answering any default questions in the pull request.
7. Pay attention to any automated failures reported in the pull request, and stay involved in the
conversation.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
GitHub provides additional document on [forking a repository][gh-forks] and [creating a pull request][gh-pull-requests].

### Contributor Flow

This is a rough outline of what a contributor's workflow looks like:
This is a rough outline of the contributor workflow:

- Create a topic branch from where you want to base your work.
- Make commits of logical units.
- Make sure your commit messages are [in the proper format](http:https://chris.beams.io/posts/git-commit/).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request.
- Make sure your commit messages are [in the proper format][conventional-commits]
- Push your changes to the topic branch in your fork.
- Submit a pull request. If the pull request is a work in progress, please open as draft.

Example:

Expand All @@ -64,7 +66,8 @@ git push origin feat/foo

### Staying In Sync With Upstream

When your branch gets out of sync with the `vmware-samples/develop`` branch, use the following to update:
When your branch gets out of sync with the `vmware-samples/develop` branch, use the following to
update:

```shell
git checkout feat/foo
Expand All @@ -75,11 +78,11 @@ git push --force-with-lease origin feat/foo

### Updating Pull Requests

If your pull request fails to pass or needs changes based on code review, you'll most likely want to squash these
changes into existing commits.
If your pull request fails to pass or needs changes based on code review, you'll most likely want to
squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
amend the commit.
If your pull request contains a single commit or your changes are related to the most recent commit,
you can simply amend the commit.

```shell
git add .
Expand All @@ -96,30 +99,36 @@ git rebase -i --autosquash develop
git push --force-with-lease origin feat/foo
```

Be sure to add a comment to the pull request indicating your new changes are ready to review, as GitHub does not
generate a notification when you `git push`.
Be sure to add a comment to the pull request indicating your new changes are ready to review, as
GitHub does not generate a notification when you `git push`.

### Formatting Commit Messages

We follow the conventions on [How to Write a Git Commit Message](http:https://chris.beams.io/posts/git-commit/).
We follow the conventions on [How to Write a Git Commit Message][git-commit].

Be sure to include any related GitHub issue references in the commit message.

See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing
issues and commits.

## Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format conventions above.
See the GitHub [documentation][gh-markdown] for referencing issues and commits.

## Finding Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on. If you have an idea you'd like to
discuss, [open a discussion](https://github.com/vmware-samples/packer-examples-for-vsphere/discussions).
Looking at the existing issues is a great way to find something to contribute on. If you have an
idea you'd like to discuss, [open a discussion][gh-discussions].

## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
See the [LICENSE][license] file for our project's licensing. We will ask you to confirm the
licensing of your contribution.

We may ask you to sign a [Contributor License Agreement (CLA)](http:https://en.wikipedia.org/wiki/Contributor_License_Agreement)
We may ask you to sign a [Contributor License Agreement (CLA)][cla]
for larger changes.

[cla]: http:https://en.wikipedia.org/wiki/Contributor_License_Agreement
[conventional-commits]: https://conventionalcommits.org
[gh-discussions]: https://github.com/vmware-samples/packer-examples-for-vsphere/discussions
[gh-forks]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
[gh-issues]: https://github.com/vmware-samples/packer-examples-for-vsphere/issues
[gh-markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github
[gh-pull-requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
[git-commit]: https://cbea.ms/git-commit
[license]: LICENSE
2 changes: 1 addition & 1 deletion MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Copyright 2023-2024 Broadcom. All rights reserved.

The following are maintainers of this project.

**Ryan Johnson**
**Ryan Johnson**
Product Engineering, VMware by Broadcom

[![@tenthirtyam](https://img.shields.io/badge/GitHub-100000?style=flat-square&logo=github&logoColor=white)](https://github.com/tenthirtyam)
1 change: 0 additions & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ docs-uninstall:
pip uninstall mkdocs-material mkdocs -y
pip uninstall -r .github/workflows/requirements.txt -y


.PHONY: update-build-script update-gitlab-ci
update-build-script:
gomplate -c build.yaml -f build.tmpl -o build.sh
Expand Down
Loading

0 comments on commit 3b5302c

Please sign in to comment.