├── MAINTAINERS.md ├── renovate.json ├── .markdownlint.json ├── .github ├── ISSUE_TEMPLATE │ ├── FEATURE_REQUEST.md │ └── BUG_REPORT.md ├── workflows │ ├── lint.yml │ └── stale.yml └── PULL_REQUEST_TEMPLATE.md ├── SECURITY.md ├── CONTRIBUTING.md ├── CHANGELOG.md ├── README.md └── CODE_OF_CONDUCT.md /MAINTAINERS.md: -------------------------------------------------------------------------------- 1 | # Maintainers 2 | 3 | - [GitHub Username](https://github.com/username) 4 | - [GitHub Username](https://github.com/username) 5 | - [GitHub Username](https://github.com/username) 6 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "description": "Wayfair OSPO recommended presets (https://github.com/wayfair/ospo-automation/blob/main/default.json)", 4 | "extends": [ 5 | "github>wayfair/ospo-automation" 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /.markdownlint.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": true, 3 | "MD013": { 4 | "line_length": 10000, 5 | "headings": false, 6 | "code_blocks": false, 7 | "tables": false 8 | }, 9 | "MD024": { 10 | "siblings_only": true 11 | }, 12 | "MD025": { 13 | "front_matter_title": "" 14 | }, 15 | "MD041": false 16 | } 17 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest a feature for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Problem Statement 11 | 12 | Please describe the problem to be addressed by the proposed feature. 13 | 14 | ## Proposed Solution 15 | 16 | Please describe what you envision the solution to this problem would look like. 17 | 18 | ## Alternatives Considered 19 | 20 | Please briefly describe which alternatives, if any, have been considered, including merits of alternate approaches and 21 | tradeoffs being made. 22 | 23 | ## Additional Context 24 | 25 | Please provide any other information that may be relevant. 26 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: lint 2 | 3 | on: # Rebuild any PRs and main branch changes 4 | push: 5 | branches: 6 | - main 7 | - develop 8 | pull_request: 9 | 10 | jobs: 11 | markdown: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v6 15 | - name: ⬇️ lint markdown files # Lints all markdown (.md) files 16 | uses: avto-dev/markdown-lint@v1 17 | with: 18 | config: '.markdownlint.json' 19 | args: '**/*.md .github/**/*.md' 20 | renovate: 21 | runs-on: ubuntu-latest 22 | steps: 23 | - uses: actions/checkout@v6 24 | - name: 🧼 lint renovate config # Validates changes to renovate.json config file 25 | uses: suzuki-shunsuke/github-action-renovate-config-validator@v1.1.1 26 | with: 27 | config_file_path: 'renovate.json' 28 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: stale 2 | 3 | on: 4 | schedule: 5 | - cron: "0 0 * * 0" 6 | 7 | jobs: 8 | stale: 9 | runs-on: ubuntu-latest 10 | permissions: 11 | issues: write 12 | pull-requests: write 13 | steps: 14 | - name: 📆 mark stale PRs # Automatically marks inactive PRs as stale 15 | uses: actions/stale@v10 16 | with: 17 | repo-token: ${{ secrets.GITHUB_TOKEN }} 18 | days-before-stale: 60 19 | stale-issue-label: 'stale' 20 | stale-pr-label: 'stale' 21 | stale-issue-message: 'Automatically marking issue as stale due to lack of activity' 22 | stale-pr-message: 'Automatically marking pull request as stale due to lack of activity' 23 | days-before-close: 7 24 | close-issue-message: 'Automatically closing this issue as stale' 25 | close-pr-message: 'Automatically closing this pull request as stale' 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/BUG_REPORT.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Report a bug to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Description 11 | 12 | Please provide a description of the problem. 13 | 14 | ## Expected Behaviour 15 | 16 | Please describe what you expected would happen. 17 | 18 | ## Actual Behaviour 19 | 20 | Please describe what happened instead. 21 | 22 | ## Affected Version 23 | 24 | Please provide the version number where this issue was encountered. 25 | 26 | ## Steps to Reproduce 27 | 28 | 1. First step 29 | 1. Second step 30 | 1. etc. 31 | 32 | ## Checklist 33 | 34 | 35 | - [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md) 36 | - [ ] I have verified this does not duplicate an existing issue 37 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references. 4 | 5 | Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all. 6 | 7 | ## Type of Change 8 | 9 | - [ ] Bug Fix 10 | - [ ] New Feature 11 | - [ ] Breaking Change 12 | - [ ] Refactor 13 | - [ ] Documentation 14 | - [ ] Other (please describe) 15 | 16 | ## Checklist 17 | 18 | 19 | - [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md) 20 | - [ ] Existing issues have been referenced (where applicable) 21 | - [ ] I have verified this change is not present in other open pull requests 22 | - [ ] Functionality is documented 23 | - [ ] All code style checks pass 24 | - [ ] New code contribution is covered by automated tests 25 | - [ ] All new and existing tests pass 26 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policies and Procedures 2 | 3 | This document outlines security procedures and general policies for the 4 | `` project. 5 | 6 | - [Reporting a Bug](#reporting-a-bug) 7 | - [Disclosure Policy](#disclosure-policy) 8 | - [Comments on this Policy](#comments-on-this-policy) 9 | 10 | ## Reporting a Bug 11 | 12 | The `` team and community take all security bugs in 13 | `` seriously. Thank you for improving the security of 14 | ``. We appreciate your efforts and responsible disclosure and 15 | will make every effort to acknowledge your contributions. 16 | 17 | Report security bugs by emailing `OpenSource@wayfair.com`. 18 | 19 | The lead maintainer will acknowledge your email within 48 hours, and will send a 20 | more detailed response within 48 hours indicating the next steps in handling 21 | your report. After the initial reply to your report, the security team will 22 | endeavor to keep you informed of the progress towards a fix and full 23 | announcement, and may ask for additional information or guidance. 24 | 25 | ## Disclosure Policy 26 | 27 | When the security team receives a security bug report, they will assign it to a 28 | primary handler. This person will coordinate the fix and release process, 29 | involving the following steps: 30 | 31 | - Confirm the problem and determine the affected versions. 32 | - Audit code to find any potential similar problems. 33 | - Prepare fixes for all releases still under maintenance. These fixes will be 34 | released as quickly as possible. 35 | 36 | ## Comments on this Policy 37 | 38 | If you have suggestions on how this process could be improved please submit a 39 | pull request. 40 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | Thanks for your interest in contributing to ``! Here are a few general guidelines on contributing and 4 | reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of 5 | the contributors managing and developing this open source project. In return, they should reciprocate that respect in 6 | addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect, 7 | we endeavour to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull 8 | requests after 60 days of inactivity. 9 | 10 | Please note that all of your interactions in the project are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). This 11 | includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in 12 | any real-time space (eg. Slack, Discord, etc). 13 | 14 | ## Reporting Issues 15 | 16 | Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our 17 | [issues list](https://github.com/org_name/repo_name/issues). 18 | 19 | When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as 20 | possible, and, if possible, a test case. 21 | 22 | **If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in 23 | [SECURITY.md](SECURITY.md).** 24 | 25 | ## Sending Pull Requests 26 | 27 | Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix 28 | has been discussed in the past, or if the change was already implemented but not yet released. 29 | 30 | We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may 31 | reserve breaking changes until the next major version release. 32 | 33 | ## Other Ways to Contribute 34 | 35 | We welcome anyone that wants to contribute to `` to triage and reply to open issues to help troubleshoot 36 | and fix existing bugs. Here is what you can do: 37 | 38 | - Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, 39 | providing feedback to the issue's author on what might be missing. 40 | - Review and update the existing content of our [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date 41 | instructions and code samples. 42 | - Review existing pull requests, and testing patches against real existing applications that use ``. 43 | - Write a test, or add a missing test case to an existing test. 44 | 45 | Thanks again for your interest on contributing to ``! 46 | 47 | :heart: 48 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## [Unreleased] 9 | 10 | ### TBA 11 | 12 | ## [0.3.9] - 2022-11-08 13 | 14 | ### Changed 15 | 16 | - Leveraging [hosted presets](https://docs.renovatebot.com/config-presets/) for `renovate.json` config 17 | 18 | ## [0.3.8] - 2022-08-15 19 | 20 | ### Added 21 | 22 | - Recommended configuration for [renovate](https://github.com/renovatebot/renovate) 23 | - Linting workflow for `renovate.json` config 24 | 25 | ### Changed 26 | 27 | - Pinned v4 of [github-pages-deploy-action](https://github.com/marketplace/actions/deploy-to-github-pages) 28 | - Removed [dependabot](https://github.com/dependabot) configuration 29 | 30 | ## [0.3.7] - 2022-04-04 31 | 32 | ### Changed 33 | 34 | - Update lint workflow trigger behavior 35 | 36 | ## [0.3.6] - 2022-03-22 37 | 38 | ### Added 39 | 40 | - Adds new template badges to README 41 | 42 | ### Changed 43 | 44 | - Bumps [actions/checkout](https://github.com/marketplace/actions/checkout) from v2 to v3 45 | 46 | ## [0.3.5] - 2021-10-21 47 | 48 | ### Added 49 | 50 | - Add step to update contact information in Code of Conduct 51 | 52 | ## [0.3.4] - 2021-10-19 53 | 54 | ### Added 55 | 56 | - Dependabot configuration 57 | 58 | ## [0.3.3] - 2021-10-07 59 | 60 | ### Added 61 | 62 | - Markdown linting 63 | 64 | ## [0.3.2] - 2021-08-24 65 | 66 | ### Added 67 | 68 | - Version badge in README links to this changelog 69 | 70 | ## [0.3.1] - 2021-08-02 71 | 72 | ### Added 73 | 74 | - This changelog 75 | 76 | ### Changed 77 | 78 | - Add versioning badge to README 79 | - Add step to remove contents of changelog to prevent confusion 80 | 81 | ## [0.3.0] - 2021-07-21 82 | 83 | ### Added 84 | 85 | - Integrate stale action 86 | 87 | ### Changed 88 | 89 | - Add "Before you begin" section to README 90 | 91 | ## [0.2.1] - 2021-06-08 92 | 93 | ### Changed 94 | 95 | - Add explanation of why PR descriptions are so important 96 | 97 | ## [0.2.0] - 2021-06-03 98 | 99 | ### Added 100 | 101 | - Pull request template 102 | - Bug report template 103 | - Feature request template 104 | 105 | ## [0.1.1] - 2021-05-24 106 | 107 | ### Changed 108 | 109 | - Be more explicit about where the code of conduct applies 110 | 111 | ## [0.1.0] - 2021-05-11 112 | 113 | ### Added 114 | 115 | - Contributor Covenant 116 | - Contribution guidelines 117 | - Maintainers file 118 | - README template 119 | - Security guidance 120 | 121 | [unreleased]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.9...HEAD 122 | [0.3.9]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.8...v0.3.9 123 | [0.3.8]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.7...v0.3.8 124 | [0.3.7]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.6...v0.3.7 125 | [0.3.6]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.5...v0.3.6 126 | [0.3.5]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.4...v0.3.5 127 | [0.3.4]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.3...v0.3.4 128 | [0.3.3]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.2...v0.3.3 129 | [0.3.2]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.1...v0.3.2 130 | [0.3.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.0...v0.3.1 131 | [0.3.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.1...v0.3.0 132 | [0.2.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.0...v0.2.1 133 | [0.2.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.1...v0.2.0 134 | [0.1.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.0...v0.1.1 135 | [0.1.0]: https://github.com/wayfair-incubator/oss-template/releases/tag/v0.1.0 136 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Open Source Project Template 2 | 3 | [![Release](https://img.shields.io/github/v/release/wayfair-incubator/oss-template?display_name=tag)](CHANGELOG.md) 4 | [![Lint](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml) 5 | [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md) 6 | [![Maintainer](https://img.shields.io/badge/Maintainer-Wayfair-7F187F)](https://wayfair.github.io) 7 | 8 | ## Before You Start 9 | 10 | As much as possible, we have tried to provide enough tooling to get you up and running quickly and with a minimum of effort. This includes sane defaults for documentation; templates for bug reports, feature requests, and pull requests; and [GitHub Actions](https://github.com/features/actions) that will automatically manage stale issues and pull requests. This latter defaults to labeling issues and pull requests as stale after 60 days of inactivity, and closing them after 7 additional days of inactivity. These [defaults](.github/workflows/stale.yml) and more can be configured. For configuration options, please consult the documentation for the [stale action](https://github.com/actions/stale). 11 | 12 | In trying to keep this template as generic and reusable as possible, there are some things that were omitted out of necessity and others that need a little tweaking. Before you begin developing in earnest, there are a few changes that need to be made: 13 | 14 | - [ ] ✅ Select an appropriate license for your project. This can easily be achieved through the 'Add File' button on the GitHub UI, naming the file `LICENSE`, and selecting your desired license from the provided list. 15 | - [ ] Update the `` placeholder in this file to reflect the name of the license you selected above. 16 | - [ ] Replace `[INSERT CONTACT METHOD]` in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication channel. 17 | - [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `wayfair-incubator`): 18 | - [ ] In [`README.md`](README.md) 19 | - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) 20 | - [ ] Change references to `repo_name` to the name of your new repo: 21 | - [ ] In [`README.md`](README.md) 22 | - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) 23 | - [ ] Update the link to the contribution guidelines to point to your project: 24 | - [ ] In [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) 25 | - [ ] In [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) 26 | - [ ] Replace the `` placeholder with the name of your project: 27 | - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) 28 | - [ ] In [`SECURITY.md`](SECURITY.md) 29 | - [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md). 30 | - [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/). 31 | - [ ] Configure [`renovate.json`](renovate.json) for your project's language and tooling dependencies. 32 | - [ ] Note that the base `renovate.json` file included with this template inherits most of its configuration logic from Wayfair OSPO's recommended presets, hosted [here](https://github.com/wayfair/ospo-automation/blob/main/default.json). If your project does not require advanced dependency configuration, this may be sufficient for your needs. 33 | - [ ] 💡 To learn more about using and configuring [Renovate](http://renovatebot.com/), check out our [wayfair.github.io](https://wayfair.github.io) article: **[Managing Project Dependencies](https://wayfair.github.io/docs/managing-dependencies/)**. 34 | - [ ] Replace the generic content in this file with the relevant details about your project. 35 | - [ ] Acknowledge that some features like [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule) are only available when the repo is `public`. 36 | - [ ] 🚨 Delete this section of the `README`! 37 | 38 | ## About The Project 39 | 40 | Provide some information about what the project is/does. 41 | 42 | ## Getting Started 43 | 44 | To get a local copy up and running follow these simple steps. 45 | 46 | ### Prerequisites 47 | 48 | This is an example of how to list things you need to use the software and how to install them. 49 | 50 | - npm 51 | 52 | ```sh 53 | npm install npm@latest -g 54 | ``` 55 | 56 | ### Installation 57 | 58 | 1. Clone the repo 59 | 60 | ```sh 61 | git clone https://github.com/org_name/repo_name.git 62 | ``` 63 | 64 | 2. Install NPM packages 65 | 66 | ```sh 67 | npm install 68 | ``` 69 | 70 | ## Usage 71 | 72 | Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. 73 | 74 | _For more examples, please refer to the [Documentation](https://example.com) or the [Wiki](https://github.com/org_name/repo_name/wiki)_ 75 | 76 | ## Roadmap 77 | 78 | See the [open issues](https://github.com/org_name/repo_name/issues) for a list of proposed features (and known issues). 79 | 80 | ## Contributing 81 | 82 | Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md) 83 | 84 | ## License 85 | 86 | Distributed under the `` License. See [LICENSE](LICENSE) for more information. 87 | 88 | ## Contact 89 | 90 | Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email 91 | 92 | Project Link: [https://github.com/org_name/repo_name](https://github.com/org_name/repo_name) 93 | 94 | ## Acknowledgements 95 | 96 | This template was adapted from 97 | [https://github.com/othneildrew/Best-README-Template](https://github.com/othneildrew/Best-README-Template). 98 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | [INSERT CONTACT METHOD]. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available 126 | at [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | --------------------------------------------------------------------------------