Skip to content

Commit

Permalink
Update CONTRIBUTING, SUPPORT, and CODE_OF_CONDUCT (#65)
Browse files Browse the repository at this point in the history 
* Update CONTRIBUTING.md

* Add SUPPORT.md

* Link SUPPORT.md from README.md

* Update CODE_OF_CONDUCT.md
  • Loading branch information
@blindaa121
blindaa121 committed Apr 27, 2022
1 parent efdfbc4 commit 72dd7e8
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 200 deletions.
144 changes: 46 additions & 98 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,127 +2,75 @@

## Our Pledge

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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community 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 a positive environment for our
community include:
Examples of behavior that contributes to creating a positive environment
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,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
- 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 include:
Examples of unacceptable behavior by participants 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
- 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 email
address, without their explicit permission
- 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

## Enforcement Responsibilities
## Our 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.
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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.
Project maintainers 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, 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 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 e-mail 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 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 to the community leaders responsible for enforcement at
@bourdakos1 on Twitter.
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:

### 1. Correction

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

### 2. Warning
reported by contacting the project team at github@paloaltonetworks.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

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

### 3. Temporary Ban

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

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

**Consequence**: A permanent ban from any sort of public interaction within
the community.
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

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
enforcement ladder](https://github.com/mozilla/diversity).
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
144 changes: 42 additions & 102 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,118 +1,58 @@
# Contributing to Docusaurus OpenAPI
# How to contribute

Our goal is to make API documentation a seamless experience for both the developers creating and the ones using them. In order to achieve this, we built Docusaurus OpenAPI from scratch to be a native extension to Docusaurus. If you're interested in contributing to Docusaurus OpenAPI, hopefully, this document makes the process for contributing easier.
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

## Get Involved
It's people like you that make security open source such a force in preventing
successful cyber-attacks. Following these guidelines helps keep the project
maintainable, easy to contribute to, and more secure. Thank you for taking the
time to follow this guide.

There are many ways to contribute, and many of them do not involve writing any code. Here's a few ideas to get started:
## Where to start

- Simply start using Docusaurus OpenAPI. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/new).
- Look through the [open issues](https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues). Provide workarounds, ask for clarification, or suggest labels.
- If you find an issue you would like to fix, [open a pull request](https://github.com/cloud-annotations/docusaurus-plugin-openapi/blob/main/CONTRIBUTING.md#your-first-pull-request). Issues tagged as _[Good first issue are](https://github.com/cloud-annotations/docusaurus-plugin-openapi/labels/Good%20first%20issue)_ a good place to get started.
- Read through our documentation (READMEs or even this page). If you find anything that is confusing or can be improved, you can click the "pencil 鉁忥笍" icon at the top of the file, which will take you to the GitHub interface to make and propose changes.
There are many ways to contribute. You can fix a bug, improve the documentation,
submit bug reports and feature requests, or take a first shot at a feature you
need for yourself.

Contributions are very welcome. If you think you need help planning your contribution, please reach out to our maintainer on Twitter at [@bourdakos1](https://twitter.com/bourdakos1) and let us know you are looking for a bit of help.
Pull requests are necessary for all contributions of code or documentation.

## Our Development Process
## New to open source?

All work on Docusaurus OpenAPI happens directly on GitHub. All changes will be public through pull requests and go through the same review process.
If you're **new to open source** and not sure what a pull request is, welcome!!
We're glad to have you! All of us once had a contribution to make and didn't
know where to start.

All pull requests will be checked by the continuous integration system, GitHub actions. There are unit tests, end-to-end tests and code style/lint tests.
Even if you don't write code for your job, don't worry, the skills you learn
during your first contribution to open source can be applied in so many ways,
you'll wonder what you ever did before you had this knowledge. It's worth
learning.

### Branch Organization
[Learn how to make a pull request](https://github.com/PaloAltoNetworks/.github/blob/master/Learn-GitHub.md#learn-how-to-make-a-pull-request)

Docusaurus OpenAPI has one primary branch `main`. We don't use separate branches for development or for upcoming releases.
## Fixing a typo, or a one or two line fix

## Proposing a Change
Many fixes require little effort or review, such as:

If you would like to request a new feature or enhancement, but are not yet thinking about opening a pull request, you can also [open an issue](https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/new).
> - Spelling / grammar, typos, white space and formatting changes
> - Comment clean up
> - Change logging messages or debugging output
> These small changes can be made directly in GitHub if you like.
If you intend to change the public API (e.g., changes to the options available to the user in `docusaurus.config.js`) or make any non-trivial changes to the implementation, we recommend filing an issue to propose your change. This lets us reach an agreement on your proposal before you put significant effort into it. These types of issues should be rare.
Click the pencil icon in GitHub above the file to edit the file directly in
GitHub. This will automatically create a fork and pull request with the change.
See:
[Make a small change with a Pull Request](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github/)

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend filing an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
## Bug fixes and features

### Bugs
For something that is bigger than a one or two line fix, go through the process
of making a fork and pull request yourself:

We use [GitHub Issues](https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues) for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new, unreported bug, you can submit a bug report.

If you have questions about using Docusaurus OpenAPI, contact our maintainer on Twitter at [@bourdakos1](https://twitter.com/bourdakos1), and we will do our best to answer your questions.

## Pull Requests

### Your First Pull Request

So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

#### Repo Setup

1. Fork [the repository](https://github.com/cloud-annotations/docusaurus-plugin-openapi) and create your branch from `main`.

```sh
git clone git@github.com:your-username/docusaurus-plugin-openapi.git
git checkout -b your-feature-or-fix-name
```

#### Installation

1. Ensure you have [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) installed.
2. After cloning the repository, run `yarn install` in the root of the repository.

```sh
cd where-you-cloned-docusaurus-plugin-openapi
yarn install
```

#### Build

1. Build all packages and generate the static content of the demo.

```sh
yarn build
```

2. Serve the generated demo site.

```sh
yarn serve
```

3. Visit [http://localhost:3000/](http://localhost:3000/) or wherever the build directory is being served.

#### Development Workflow

For faster iterations, packages can be built and watched by running:

```sh
yarn watch
```

And in a seperate terminal window, the demo can be built and watched by running:

```sh
yarn watch:demo
```

#### Testing

Before we merge your code into our main branch, we expect it to pass four test groups (format, linting, unit tests and end-to-end tests).

1. **Format**: We use Husky pre-commit hooks and Prettier to automatically format your code, so you shouldn't need to worry too much about this one.
Husky and Prettier

2. **Linting**: We use ESLint to testing for linting errors and warnings. To check to see if your code has any linting issues you can run:

```sh
yarn lint
```

3. **Unit Tests**: We use Jest for unit testing. Run the unit tests with:

```sh
yarn test
```

4. **End-to-End Tests**: We use Cypress for end-to-end testing. Run the end-to-end with:

```sh
yarn test:cypress
```
> 1. Create your own fork of the code
> 2. Clone the fork locally
> 3. Make the changes in your local clone
> 4. Push the changes from local to your fork
> 5. Create a pull request to pull the changes from your fork back into the
> upstream repository
> Please use clear commit messages so we can understand what each commit does.
> We'll review every PR and might offer feedback or request changes before
> merging.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,7 @@ For more insight into why we decided to completely fork see [#47](https://github
<a href="https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/graphs/contributors">
<img src="https://contrib.rocks/image?repo=PaloAltoNetworks/docusaurus-openapi-docs" />
</a>

## Support

Please read [SUPPORT.md](SUPPORT.md) for details on how to get support for this project.
15 changes: 15 additions & 0 deletions SUPPORT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Community Supported

The software and templates in the repo are released under an as-is, best effort,
support policy. This software should be seen as community supported and Palo
Alto Networks will contribute our expertise as and when possible. We do not
provide technical support or help in using or troubleshooting the components of
the project through our normal support options such as Palo Alto Networks
support teams, or ASC (Authorized Support Centers) partners and backline support
options. The underlying product used (the VM-Series firewall) by the scripts or
templates are still supported, but the support is only for the product
functionality and not for help in deploying or using the template or script
itself. Unless explicitly tagged, all projects or work posted in our GitHub
repository (at https://github.com/PaloAltoNetworks) or sites other than our
official Downloads page on https://support.paloaltonetworks.com are provided
under the best effort policy.

0 comments on commit 72dd7e8

Please sign in to comment.