diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..afc63ba --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..091d81b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,36 @@ +name: "Issue report" +description: Report an unexpected problem or unintended behavior. +labels: ["needs triage"] +body: + - type: markdown + attributes: + value: | + ### Before you start + + **Want to fix the problem yourself?** This project is open source and we welcome fixes and improvements from the community! + + ↩ Check the project [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) guide to see how to get started. + + --- + - type: textarea + id: problem + attributes: + label: What information was incorrect, unhelpful, or incomplete? + validations: + required: true + - type: textarea + id: expected + attributes: + label: What did you expect to see? + validations: + required: true + - type: textarea + id: references + attributes: + label: Do you have any supporting links, references, or citations? + description: Link to information that helps us confirm your issue. + - type: textarea + id: more-info + attributes: + label: Do you have anything more you want to share? + description: For example, steps to reproduce, screenshots, screen recordings, or sample code. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..03d9f6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: true +contact_links: + - name: Content or feature request + url: https://github.com/mdn/mdn/issues/new/choose + about: Propose new content for MDN Web Docs or submit a feature request using this link. + - name: MDN GitHub Discussions + url: https://github.com/orgs/mdn/discussions + about: Does the issue involve a lot of changes, or is it hard to split it into actionable tasks? Start a discussion before opening an issue. + - name: MDN Web Docs on Discourse + url: https://discourse.mozilla.org/c/mdn/learn/250 + about: Need help with assessments on MDN Web Docs? We have a support community for this purpose on Discourse. + - name: Help with code + url: https://stackoverflow.com/ + about: If you are stuck and need help with code, StackOverflow is a great resource. diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..14435af --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,19 @@ + + +### Description + + + +### Motivation + + + +### Additional details + + + +### Related issues and pull requests + + + + diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..0c4086e --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,42 @@ +name: "CodeQL" + +on: + push: + branches: ["main"] + paths-ignore: + - "**.md" + pull_request: + # The branches below must be a subset of the branches above + branches: ["main"] + paths-ignore: + - "**.md" + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + matrix: + # Add the language(s) you want to analyze here as an array of strings + # for example: ['javascript'] or ['python', 'javascript'] + language: ["javascript"] + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/idle.yml b/.github/workflows/idle.yml new file mode 100644 index 0000000..38ceb3a --- /dev/null +++ b/.github/workflows/idle.yml @@ -0,0 +1,13 @@ +# This workflow is hosted at: https://github.com/mdn/workflows/blob/main/.github/workflows/idle.yml +# Docs for this workflow: https://github.com/mdn/workflows/blob/main/README.md#idle +name: "Label idle issues" + +on: + schedule: + - cron: "0 8 * * *" + +jobs: + mark-as-idle: + uses: mdn/workflows/.github/workflows/idle.yml@main + with: + target-repo: "mdn/webextensions-examples" diff --git a/.github/workflows/welcome-bot.yml b/.github/workflows/welcome-bot.yml new file mode 100644 index 0000000..bd64dd7 --- /dev/null +++ b/.github/workflows/welcome-bot.yml @@ -0,0 +1,35 @@ +# This workflow is hosted at: https://github.com/mdn/workflows/blob/main/.github/workflows/allo-allo.yml +# Docs for this workflow: https://github.com/mdn/workflows/blob/main/README.md#allo-allo +name: "AlloAllo" + +on: + issues: + types: + - opened + pull_request_target: + branches: + - main + types: + - opened + - closed + +jobs: + allo-allo: + uses: mdn/workflows/.github/workflows/allo-allo.yml@main + with: + target-repo: "mdn/webextensions-examples" + issue-welcome: > + It looks like this is your first issue. Welcome! 👋 + One of the project maintainers will be with you as soon as possible. We + appreciate your patience. To safeguard the health of the project, please + take a moment to read our [code of conduct](../blob/main/CODE_OF_CONDUCT.md). + pr-welcome: > + It looks like this is your first pull request. 🎉 + Thank you for your contribution! One of the project maintainers will triage + and assign the pull request for review. We appreciate your patience. To + safeguard the health of the project, please take a moment to read our + [code of conduct](../blob/main/CODE_OF_CONDUCT.md). + pr-merged: > + Congratulations on your first merged pull request. 🎉 Thank you for your contribution! + Did you know we have a [project board](https://github.com/orgs/mdn/projects/25) with high-impact contribution opportunities? + We look forward to your next contribution. diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1 @@ +{} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 50e26b1..bd86da5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,8 +1,8 @@ -# Community Participation Guidelines +# Code of conduct -This repository is governed by Mozilla's code of conduct and etiquette guidelines. -For more details, please read the -[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). +This repository is governed by Mozilla's code of conduct and etiquette guidelines. +For more details, read [Mozilla's Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). -## How to Report -For more information on how to report violations of the Community Participation Guidelines, please read our [How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/) page. +## Reporting violations + +For more information on how to report violations of the Community Participation Guidelines, read the [How to report](https://www.mozilla.org/about/governance/policies/participation/reporting/) page.