From 6b984183eb68b625d3a44f6685d44278ea0814c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josh=20Goldberg=20=E2=9C=A8?= Date: Sat, 6 Jul 2024 19:27:42 -0400 Subject: [PATCH] chore: brought in standard templates from mochajs/mocha (#96) --- .github/CODE_OF_CONDUCT.md | 103 ++++++++++++++++++ .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/01-bug.yml | 47 ++++++++ .github/ISSUE_TEMPLATE/02-documentation.yml | 27 +++++ .github/ISSUE_TEMPLATE/03-example-request.yml | 39 +++++++ .../ISSUE_TEMPLATE/04-repository-tooling.yml | 31 ++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++ .github/PULL_REQUEST_TEMPLATE.md | 13 +++ README.md | 5 +- 9 files changed, 279 insertions(+), 1 deletion(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/01-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/02-documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/03-example-request.yml create mode 100644 .github/ISSUE_TEMPLATE/04-repository-tooling.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d4d5a7a --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,103 @@ +# Mocha Code of Conduct + +## Be friendly and patient + +We understand that everyone has different levels of experience or knowledge in many diverse fields, be it technical or +non-technical in nature. +We also have areas of knowledge we are eager to expand; we want to be a community where people can not only contribute, but feel comfortable to ask questions as well and learn along the way. +If someone says something wrong, or says something accidentally offensive, respond with patience and try to keep it polite and civil. +Remember that we all were newbies at one point. + +## Be welcoming + +We strive to be a community that welcomes and supports people of all backgrounds and identities. +This includes, but is not limited to, members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability. + +## Be considerate + +Your work will be used by other people, and you in turn will depend on the work of others. +Any decision you make will affect users and colleagues, and you should take those consequences into account when making decisions. +Remember that we’re a world-wide community, so you might not be communicating in someone else’s primary language. + +## Be respectful + +Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. +We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. +It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. +Members of the OpenJS Foundation community should be respectful when dealing with other members as well as with people outside the OpenJS Foundation community. + +## Be careful in the words that you choose + +We are a community of professionals, and we conduct ourselves professionally. +Be kind to others. +Do not insult or put down other participants. +Harassment and other exclusionary behavior aren’t acceptable. +This includes, but is not limited to: + +- Violent threats or language directed against another person. +- Discriminatory jokes and language. +- Posting sexually explicit or violent material. +- Posting (or threatening to post) other people’s personally identifying information (“doxing”). +- Personal insults, especially those using racist or sexist terms. +- Unwelcome sexual attention. +- Advocating for, or encouraging, any of the above behavior. +- Repeated harassment of others. + In general, if someone asks you to stop, then stop. + +## When we disagree, try to understand why + +Disagreements, both social and technical, happen all the time and OpenJS Foundation projects are no exception. +It is important that we resolve disagreements and differing views constructively. +Remember that we’re different. +The strength of the OpenJS Foundation comes from its varied community, people from a wide range of backgrounds. +Different people have different perspectives on issues. +Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. +Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. +Instead, focus on helping to resolve issues and learning from mistakes. + +Original text courtesy of the Speak Up! project and Django Project. + +## QUESTIONS? + +If you have questions, please see the FAQ. +If that doesn’t answer your questions, feel free to email report@lists.openjsf.org. + +# OpenJS Foundation Code of Conduct + +The OpenJS Foundation and its member projects use the Contributor Covenant v1.4.1 as its Code of Conduct. +Refer to the following for the full text: + +- [Contributor Covenant v1.4.1 in english](https://www.contributor-covenant.org/version/1/4/code-of-conduct) +- [Contributor Covenant v1.4.1 translations](https://www.contributor-covenant.org/translations) + +Refer to the section on reporting and escalation in this document for the specific emails that can be used to report and escalate issues. + +## Reporting + +### Project Spaces + +For reporting issues in spaces related to a member project please use the email provided by the project for reporting. +Projects handle CoC issues related to the spaces that they maintain. +Projects maintainers commit to: + +- maintain the confidentiality with regard to the reporter of an incident +- to participate in the path for escalation as outlined in + the section on Escalation when required. + +### Foundation Spaces + +For reporting issues in spaces managed by the OpenJS Foundation, for example, repositories within the OpenJS organization, use the email `report@lists.openjsf.org`. +The Cross Project Council (CPC) is responsible for managing these reports and commits to: + +- maintain the confidentiality with regard to the reporter of an incident +- to participate in the path for escalation as outlined in + the section on Escalation when required. + +## Escalation + +The OpenJS Foundation maintains a Code of Conduct Panel (CoCP). +This is a foundation-wide team established to manage escalation when a reporter believes that a report to a member project or the CPC has not been properly handled. +In order to escalate to the CoCP send an email to `"coc-escalation@lists.openjsf.org`. + +For more information, refer to the full +[Code of Conduct governance document](https://github.com/openjs-foundation/cross-project-council/tree/main/proposals/approved/CODE_OF_CONDUCT). diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..c63669a --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +open_collective: mochajs diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml new file mode 100644 index 0000000..514f297 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug.yml @@ -0,0 +1,47 @@ +body: + - attributes: + description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you! + label: Bug Report Checklist + options: + - label: I have read and agree to Mocha's [Code of Conduct](https://github.com/mochajs/mocha-examples/blob/main/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md) + required: true + - label: I have searched for [related issues](https://github.com/mochajs/mocha-examples/issues?q=is%3Aissue) and [issues with the `faq` label](https://github.com/mochajs/mocha-examples/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Afaq%20), but none matched my issue. + required: true + - label: I have 'smoke tested' the code to be tested by running it outside the real test suite to get a better sense of whether the problem is in the code under test, my usage of Mocha, or Mocha itself. + required: true + - label: I want to provide a PR to resolve this + type: checkboxes + - attributes: + description: What did you expect to happen? + label: Expected + type: textarea + validations: + required: true + - attributes: + description: What happened instead? + label: Actual + type: textarea + validations: + required: true + - attributes: + description: Detail the steps necessary to reproduce the problem. To get the fastest support, create an [MCVE](https://stackoverflow.com/help/mcve) and upload it to GitHub. + label: Minimal, Reproducible Example + type: textarea + validations: + required: true + - attributes: + description: What do `mocha --version`, `node_modules/.bin/mocha --version`, and `node --version` output? What name and version of browser/environment, shell, and any other related modules such as transpilers are you using?. + label: Versions + type: textarea + validations: + required: true + - attributes: + description: Any additional info you'd like to provide. + label: Additional Info + type: textarea +description: Report a bug trying to run the code +labels: + - 'status: in triage' + - 'type: bug' +name: 🐛 Bug +title: '🐛 Bug: ' diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yml b/.github/ISSUE_TEMPLATE/02-documentation.yml new file mode 100644 index 0000000..e75ef56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-documentation.yml @@ -0,0 +1,27 @@ +body: + - attributes: + description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you! + label: Documentation Request Checklist + options: + - label: I have read and agree to Mocha's [Code of Conduct](https://github.com/mochajs/mocha-examples/blob/main/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md) + required: true + - label: I have searched for [related issues](https://github.com/mochajs/mocha-examples/issues?q=is%3Aissue) and [issues with the `faq` label](https://github.com/mochajs/mocha-examples/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Afaq%20), but none matched my issue. + required: true + - label: I want to provide a PR to resolve this + type: checkboxes + - attributes: + description: What would you like to report? + label: Overview + type: textarea + validations: + required: true + - attributes: + description: Any additional info you'd like to provide. + label: Additional Info + type: textarea +description: Report a typo or missing area of documentation +labels: + - 'area: documentation' + - 'status: in triage' +name: 📝 Docs +title: '📝 Docs: ' diff --git a/.github/ISSUE_TEMPLATE/03-example-request.yml b/.github/ISSUE_TEMPLATE/03-example-request.yml new file mode 100644 index 0000000..60ad07a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-example-request.yml @@ -0,0 +1,39 @@ +body: + - attributes: + description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you! + label: Example Request Checklist + options: + - label: I have read and agree to Mocha's [Code of Conduct](https://github.com/mochajs/mocha-examples/blob/main/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md) + required: true + - label: I have searched for [related issues](https://github.com/mochajs/mocha-examples/issues?q=is%3Aissue), but none matched my issue. + required: true + - label: I want to provide a PR to resolve this + type: checkboxes + - attributes: + description: What is the feature gap or problem you'd like to address? + label: Overview + type: textarea + validations: + required: true + - attributes: + description: How would you like to solve this need? + label: Suggested Solution + type: textarea + validations: + required: true + - attributes: + description: What other features or solutions have you also considered? + label: Alternatives + type: textarea + validations: + required: true + - attributes: + description: Any additional info you'd like to provide. + label: Additional Info + type: textarea +description: Request that a new feature be added or an existing feature improved +labels: + - 'status: in triage' + - 'type: feature' +name: 🚀 Example +title: '🚀 Example: ' diff --git a/.github/ISSUE_TEMPLATE/04-repository-tooling.yml b/.github/ISSUE_TEMPLATE/04-repository-tooling.yml new file mode 100644 index 0000000..55ec331 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-repository-tooling.yml @@ -0,0 +1,31 @@ +body: + - attributes: + description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you! + label: Tooling Suggestion Checklist + options: + - label: I have tried restarting my IDE and the issue persists. + required: true + - label: I have pulled the latest `main` branch of the repository. + required: true + - label: I have read and agree to Mocha's [Code of Conduct](https://github.com/mochajs/mocha-examples/blob/main/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md) + required: true + - label: I have searched for [related issues](https://github.com/mochajs/mocha-examples/issues?q=is%3Aissue) and [issues with the `faq` label](https://github.com/mochajs/mocha-examples/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Afaq%20), but none matched my issue. + required: true + - label: I want to provide a PR to resolve this + type: checkboxes + - attributes: + description: What did you expect to be able to do? + label: Overview + type: textarea + validations: + required: true + - attributes: + description: Any additional info you'd like to provide. + label: Additional Info + type: textarea +description: Report a bug or request an enhancement in the Mocha repository's internal tooling +labels: + - 'area: repository tooling' + - 'status: in triage' +name: 🛠 Repository Tooling +title: '🛠 Repo: ' diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..14346bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: true +contact_links: + - name: Documentation Website + about: Please read our documentation website before filing new issues. + url: https://mochajs.org + - name: Documentation Website > APIs + about: If you're using Mocha's API, see also the website's API docs. + url: https://mochajs.org/api + - name: Discord + about: Our Discord is the right place for quick informal questions. + url: https://discord.gg/KeDn2uXhER + - name: StackOverflow + about: For more questions, see the `mocha` tag on StackOverflow. + url: https://stackoverflow.com/questions/tagged/mocha diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9f8ff8c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ + + +## PR Checklist + +- [ ] Addresses an existing open issue: fixes #000 +- [ ] That issue was marked as [`status: accepting prs`](https://github.com/mochajs/mocha/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) +- [ ] Steps in [CONTRIBUTING.md](https://github.com/mochajs/mocha/blob/main/.github/CONTRIBUTING.md) were taken + +## Overview + + diff --git a/README.md b/README.md index c149cd1..efa3ff5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ A set of examples to help demonstrate common configurations using Mocha. They should all run out-the-box. -[![Build Status](https://github.com/mochajs/mocha-examples/workflows/Tests/badge.svg?branch=main)](https://github.com/mochajs/mocha-examples/actions?query=workflow%3ATests+branch%3Amain) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) +Chat - Discord +Maintained with Lerna +OpenCollective Sponsors +OpenCollective Backers ## Examples