├── .prettierrc ├── .github ├── dependabot.yml ├── CODEOWNERS ├── PULL_REQUEST_TEMPLATE │ └── pull-request-template.md ├── ISSUE_TEMPLATE │ ├── nominate-invited-expert.yml │ ├── nominate-spotlight-contributor.yml │ ├── nominate-maintainer.yml │ ├── new-member-request.yml │ └── content-or-feature-suggestion.yml └── labels.json ├── CODE_OF_CONDUCT.md ├── LICENSE ├── SECURITY.md ├── README.md └── spotlight-contributors └── index.md /.prettierrc: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "npm" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | - package-ecosystem: github-actions 8 | directory: / 9 | schedule: 10 | interval: weekly 11 | commit-message: 12 | prefix: "ci(deps): " 13 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Community Participation Guidelines 2 | 3 | This repository is governed by Mozilla's code of conduct and etiquette guidelines. 4 | For more details, please read the 5 | [Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). 6 | 7 | ## How to Report 8 | 9 | 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. 10 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # ---------------------------------------------------------------------------- 2 | # CODEOWNERS 3 | # ---------------------------------------------------------------------------- 4 | # Order is important. The last matching pattern takes precedence. 5 | # See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners 6 | # ---------------------------------------------------------------------------- 7 | 8 | /.github/workflows/ @mdn/engineering 9 | /.github/CODEOWNERS @mdn/engineering 10 | /SECURITY.md @mdn/engineering 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Mechanical Ink 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE/pull-request-template.md: -------------------------------------------------------------------------------- 1 | # Nominating [GitHub username] as a [role] 2 | 3 | Thank you for taking the time to nominate a fellow contributor. Make sure you read our [list of prerequisites](https://developer.mozilla.org/en-US/docs/MDN/Community/Users_teams) for the relevant role before submitting a nomination. 4 | Please submit information for the person you are nominating in the sections listed below. 5 | 6 | ## GitHub username of the nominee (required) 7 | 8 | ## GitHub profile link of the nominee (required) 9 | 10 | ## Reason for nominating this person (required) 11 | 12 | Tell us why you are nominating this person to become a spotlight contributor. 13 | 14 | ## Supporting evidence for nominating this person (required) 15 | 16 | Provide evidence to support your nomination. The supporting information can include a list of their contributions and interactions with the community. 17 | You can also provide links to [commit logs](https://github.com/mdn/content/commits?author=mdn-bot). 18 | 19 | > Remember, contributions to this repository should follow its [code of conduct](https://github.com/mdn/mdn/blob/main/CODE_OF_CONDUCT.md). 20 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Overview 4 | 5 | This policy applies to MDN's website (`developer.mozilla.org`), backend services, and GitHub repositories in the [`mdn`](https://github.com/mdn) organization. Issues affecting other Mozilla products or services should be reported through the [Mozilla Security Bug Bounty Program](https://www.mozilla.org/en-US/security/bug-bounty/). 6 | 7 | For non-security issues, please file a [content bug](https://github.com/mdn/content/issues/new/choose), a [website bug](https://github.com/mdn/fred/issues/new/choose) or a [content/feature suggestion](https://github.com/mdn/mdn/issues/new/choose). 8 | 9 | ## Reporting a Vulnerability 10 | 11 | If you discover a potential security issue, please report it privately via . 12 | 13 | If you prefer not to use HackerOne, you can report it via . 14 | 15 | ## Bounty Program 16 | 17 | Vulnerabilities in MDN may qualify for Mozilla's Bug Bounty Program. Eligibility and reward amounts are described on . 18 | 19 | Please use the above channels even if you are not interested in a bounty reward. 20 | 21 | ## Responsible Disclosure 22 | 23 | Please do not publicly disclose details until Mozilla's security team and the MDN engineering team have verified and fixed the issue. 24 | 25 | We appreciate your efforts to keep MDN and its users safe. 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/nominate-invited-expert.yml: -------------------------------------------------------------------------------- 1 | name: Nominate an invited expert 2 | description: Use this template when nominating an invited expert. 3 | title: Nominating an invited expert for [technology topic] 4 | labels: ["invited-expert-nomination"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for taking the time to nominate an invited expert. 10 | Make sure that you have read and understood the [responsibilities of an invited expert](https://developer.mozilla.org/en-US/docs/MDN/Community/Users_teams#invited_experts_program) before submitting a nomination. 11 | - type: input 12 | attributes: 13 | label: Given name or GitHub username 14 | validations: 15 | required: true 16 | - type: input 17 | attributes: 18 | label: GitHub profile link 19 | placeholder: https://github.com/ 20 | validations: 21 | required: true 22 | - type: textarea 23 | attributes: 24 | label: Why are you nominating this person? 25 | description: Tell us why you are nominating this person to become an invited expert. 26 | validations: 27 | required: true 28 | - type: textarea 29 | attributes: 30 | label: Supporting evidence 31 | description: | 32 | Provide evidence to support your nomination such as contributions and interactions with the community. 33 | Links to [commit logs](https://github.com/mdn/content/commits?author=mdn-bot) in a repository are also appropriate. 34 | validations: 35 | required: true 36 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/nominate-spotlight-contributor.yml: -------------------------------------------------------------------------------- 1 | name: Nominate a spotlight contributor 2 | description: Use this template to nominate a spotlight contributor. 3 | title: Nominating [GitHub username] as a spotlight contributor 4 | labels: ['spotlight-contributor'] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for taking the time to nominate a [spotlight contributor](https://github.com/mdn/mdn-contributor-spotlight). 10 | Make sure you read our [list of prerequisites](https://developer.mozilla.org/en-US/docs/MDN/Community/Users_teams#spotlight-contributor) before submitting a nomination. 11 | - type: input 12 | attributes: 13 | label: Given name or GitHub username 14 | validations: 15 | required: true 16 | - type: input 17 | attributes: 18 | label: GitHub profile link 19 | placeholder: https://github.com/ 20 | validations: 21 | required: true 22 | - type: textarea 23 | attributes: 24 | label: Why are you nominating this person? 25 | description: Tell us why you are nominating this person to become a spotlight contributor. 26 | validations: 27 | required: true 28 | - type: textarea 29 | attributes: 30 | label: Supporting evidence 31 | description: | 32 | Provide evidence to support your nomination such as contributions and interactions with the community. 33 | Links to [commit logs](https://github.com/mdn/content/commits?author=mdn-bot) in a repository are also appropriate. 34 | validations: 35 | required: true 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MDN Web Docs on Github 2 | 3 | 👋 Welcome, Bienvenida, 欢迎, Bienvenue, いらっしゃいませ, Receber, Добро пожаловать, 환영합니다, მოგესალმებით 4 | 5 | ![github-profile](https://user-images.githubusercontent.com/10350960/166113119-629295f6-c282-42c9-9379-af2de5ad4338.png) 6 | 7 | Welcome to the `mdn` repository which we use to track MDN team work. 8 | The [MDN teams public projects are here](https://github.com/orgs/mdn/projects), where you can view current and upcoming tasks. 9 | 10 | This repository is also used for requests and contains issue templates for the following processes: 11 | 12 | - [Proposing new content or features for MDN Web Docs](https://github.com/mdn/mdn/issues/new/choose) 13 | - [Nominating an invited expert](https://github.com/mdn/mdn/issues/new/choose) 14 | - [Nominating a co-maintainer](https://github.com/mdn/mdn/issues/new/choose) 15 | 16 | ## Invited experts 17 | 18 | ### Joshua Chen 19 | 20 | - [GitHub](https://github.com/Josh-Cena) 21 | - Invited expert: JavaScript 22 | 23 | ### Hidde de Vries 24 | 25 | - [GitHub](https://github.com/hidde) 26 | - Invited expert: Accessibility 27 | 28 | ### Scott O'Hara 29 | 30 | - [GitHub](https://github.com/scottaohara) 31 | - Invited expert: Accessibility 32 | 33 | ### André Jaenisch 34 | 35 | - [GitHub](https://github.com/Ryuno-Ki) 36 | - Invited expert: SVG 37 | 38 | ### Mendy Berger 39 | 40 | - [GitHub](https://github.com/MendyBerger) 41 | - Invited expert: WASM 42 | 43 | > NOTE: If you wish to nominate someone to be considered as an invited expert, start by [filing an issue in this repository](https://github.com/mdn/mdn/issues/new/choose). 44 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/nominate-maintainer.yml: -------------------------------------------------------------------------------- 1 | name: Nominate a maintainer 2 | description: Use this template when nominating an individual to become a maintainer of an MDN Web Docs repository. 3 | title: Nominating a maintainer for [repository-name] 4 | labels: ["repo maintainer nomination"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for taking the time to nominate an individual to become a co-maintainer. 10 | Please ensure that you have read and understood the responsibilities of [a volunteer maintainer](https://developer.mozilla.org/en-US/docs/MDN/Community/Pull_requests) before continuing. 11 | - type: input 12 | attributes: 13 | label: Given name or GitHub username 14 | validations: 15 | required: true 16 | - type: input 17 | attributes: 18 | label: GitHub profile link 19 | placeholder: https://github.com/ 20 | validations: 21 | required: true 22 | - type: input 23 | attributes: 24 | label: Repository URL 25 | description: The URL of the repository this person will co-maintain. 26 | validations: 27 | required: true 28 | - type: textarea 29 | attributes: 30 | label: Why are you nominating this person? 31 | description: Tell us why you are nominating this person to become a co-maintainer of the repository. 32 | validations: 33 | required: true 34 | - type: textarea 35 | attributes: 36 | label: Supporting evidence 37 | description: | 38 | Provide evidence to support your nomination such as contributions and interactions with the community. 39 | Links to [commit logs](https://github.com/mdn/content/commits?author=mdn-bot) in a repository are also appropriate. 40 | validations: 41 | required: true 42 | -------------------------------------------------------------------------------- /spotlight-contributors/index.md: -------------------------------------------------------------------------------- 1 | # MDN Web Docs spotlight contributors 2 | 3 | For more details on our spotlight contributor program, see our [community documentation](https://developer.mozilla.org/en-US/docs/MDN/Community/Users_teams#spotlight_contributor). 4 | 5 | ## Archive of our spotlight contributors 6 | 7 | ### Tanner Dolby 8 | April, 2022 9 | 10 | - [On GitHub](https://github.com/tannerdolby) 11 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/tanner-dolby) 12 | 13 | ### Onkar Ruikar 14 | May, 2022 15 | 16 | - [On GitHub](https://github.com/OnkarRuikar) 17 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/onkar-ruikar) 18 | 19 | ### Queen Vinyl Da.i'gyu-Kazotetsu 20 | June, 2022 21 | 22 | - [On GitHub](https://github.com/queengooborg) 23 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/vinyl-da-i-gyu-kazotetsu) 24 | 25 | ### Julien (Sphinx on the Internets) 26 | July, 2022 27 | 28 | - [On GitHub](https://github.com/SphinxKnight) 29 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/sphinx) 30 | 31 | ### Carolyn Wu 32 | August, 2022 33 | 34 | - [On GitHub](https://github.com/cw118) 35 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/cw118) 36 | 37 | ### Michał Niedziółka 38 | September, 2022 39 | 40 | - [On GitHub](https://github.com/NiedziolkaMichal) 41 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/niedziolka-michal) 42 | 43 | ### Michael Koch 44 | October, 2022 45 | 46 | - [On GitHub](https://github.com/mikoMK) 47 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/michael-koch) 48 | 49 | ### YiTao Yin 50 | November, 2022 51 | 52 | - [On GitHub](https://github.com/yin1999) 53 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/yitao-yin) 54 | 55 | ### Yuji 56 | December, 2022 57 | 58 | - [On GitHub](https://github.com/YujiSoftware) 59 | - [On MDN Web Docs](https://developer.mozilla.org/en-US/community/spotlight/yuji) 60 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/new-member-request.yml: -------------------------------------------------------------------------------- 1 | name: New Member Request 2 | description: Use this template to request to become a member of an MDN Web Docs GitHub team 3 | title: Requesting to become a member of the [team-name] team 4 | labels: ["team membership request"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for your interest in becoming a member of an MDN Web Docs team. 10 | Please ensure that you have read what it means to be [part of a team](https://developer.mozilla.org/en-US/docs/MDN/Community/Users_teams) before continuing. 11 | - type: input 12 | attributes: 13 | label: Given name or GitHub username 14 | validations: 15 | required: true 16 | - type: input 17 | attributes: 18 | label: Your GitHub profile link 19 | placeholder: https://github.com/ 20 | validations: 21 | required: true 22 | - type: textarea 23 | attributes: 24 | label: Links to contributions made to MDN Web Docs on GitHub. 25 | placeholder: For example https://github.com/mdn/content/commits?author=mdn-bot 26 | validations: 27 | required: true 28 | - type: input 29 | attributes: 30 | label: Team name 31 | placeholder: Provide the name of the team you want to join. 32 | validations: 33 | required: true 34 | - type: checkboxes 35 | id: terms 36 | attributes: 37 | label: Code of Conduct 38 | description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/mdn/mdn/blob/main/CODE_OF_CONDUCT.md). 39 | options: 40 | - label: I agree to follow this project's Code of Conduct 41 | required: true 42 | - type: checkboxes 43 | id: terms 44 | attributes: 45 | label: Commit Access Requirements 46 | description: By submitting this issue, you agree to Mozilla's [Commit Access Requirements](https://www.mozilla.org/en-US/about/governance/policies/commit/requirements/). 47 | options: 48 | - label: I agree to follow Mozilla's Commit Access Requirements 49 | required: true 50 | - type: checkboxes 51 | id: terms 52 | attributes: 53 | label: Two-Factor Authentication 54 | description: By submitting this issue, I confirm that I have set up [Two factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) on my GitHub account. 55 | options: 56 | - label: I confirm that I have set up two-factor authentication 57 | required: true 58 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/content-or-feature-suggestion.yml: -------------------------------------------------------------------------------- 1 | name: New content or feature suggestion 2 | description: Proposals for new content or features on MDN Web Docs 3 | title: Enter your proposal here 4 | labels: ["proposal", "needs triage"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for taking the time to put together a proposal for adding/updating content or a website feature on MDN Web Docs. We have a well-defined process for handling these requests which you can read about in our [Community Guidelines](https://developer.mozilla.org/en-US/docs/MDN/Community). 10 | 11 | New or experimental web platform features must be supported in at least **one stable browser release** before documentation is published to MDN. For more information, see the [What we write](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/What_we_write#suggesting_content) and the [experimental technologies](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete) documentation. 12 | - type: textarea 13 | attributes: 14 | label: Proposal 15 | description: Please describe the content or feature you are proposing and why it is needed. 16 | validations: 17 | required: true 18 | - type: textarea 19 | attributes: 20 | label: Browser support 21 | description: Is this feature available in a stable browser release? If so, in which version is it supported? Adding links to browser implementation bugs or other documentation speeds up this process. 22 | - type: textarea 23 | attributes: 24 | label: Tasks 25 | description: What needs to be done to complete this task? 26 | value: | 27 | - [ ] 28 | - type: textarea 29 | attributes: 30 | label: Dependencies 31 | description: | 32 | Does this task depend on anything else to be completed first? Links to GitHub issues or pull requests are helpful. 33 | value: | 34 | - [ ] 35 | - type: textarea 36 | attributes: 37 | label: Additional information 38 | description: | 39 | Please add any additional information to support this proposal (screenshots, specification links, browser implementation bugs etc...) 40 | - type: input 41 | attributes: 42 | label: Are you willing to support this work? 43 | description: > 44 | MDN Web Docs is an open source project and welcomes contributions. 45 | Let us know whether you are willing to help with the proposed work and in what capacity; this can be undertaking the task itself or supporting with reviews and/or feedback. 46 | -------------------------------------------------------------------------------- /.github/labels.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "name": "p1", 4 | "color": "#E80840", 5 | "description": "top priority items" 6 | }, 7 | { 8 | "name": "p2", 9 | "color": "#D84000", 10 | "description": "high priority, will be elevated to p1 when there are no p1 items" 11 | }, 12 | { 13 | "name": "p3", 14 | "color": "#C84080", 15 | "description": "important, but not critical to our end users or infra" 16 | }, 17 | { 18 | "name": "chore", 19 | "color": "#A040F8", 20 | "description": "a routine task" 21 | }, 22 | { 23 | "name": "a11y", 24 | "color": "#B366F9", 25 | "description": "accessibility documentation or general user interface issues regarding accessibility" 26 | }, 27 | { 28 | "name": "localisation", 29 | "color": "#C68CFB", 30 | "description": "improved localisation tooling or of interest to localisers" 31 | }, 32 | { 33 | "name": "idle", 34 | "color": "#CDCDCD", 35 | "description": "there has been no activity, either address or close" 36 | }, 37 | { 38 | "name": "needs triage", 39 | "color": "#858585", 40 | "description": "automatically added to new issues, response needed within a week" 41 | }, 42 | { 43 | "name": "community", 44 | "color": "#066D05", 45 | "description": "issues, discussions, and pull requests opened by the community" 46 | }, 47 | { 48 | "name": "need info", 49 | "color": "#39A038", 50 | "description": "the author or a collaborator has requested additional information" 51 | }, 52 | { 53 | "name": "help wanted", 54 | "color": "#6BB86A", 55 | "description": "community contributions welcomed" 56 | }, 57 | { 58 | "name": "good first issue", 59 | "color": "#9CCF9B", 60 | "description": "issues intentionally kept open for first time contributors" 61 | }, 62 | { 63 | "name": "bug", 64 | "color": "#BA0633", 65 | "description": "a ghost in the machine" 66 | }, 67 | { 68 | "name": "on hold", 69 | "color": "#D36699", 70 | "description": "there is currently a dependency that is blocking progress" 71 | }, 72 | { 73 | "name": "enhancement", 74 | "color": "#135AC0", 75 | "description": "new agreed upon features or enhancement to existing content or infra" 76 | }, 77 | { 78 | "name": "github_actions", 79 | "color": "#1870F0", 80 | "description": "automatically added by dependabot for github action updates" 81 | }, 82 | { 83 | "name": "dependencies", 84 | "color": "#468DF3", 85 | "description": "automatically added by dependabot for dependency updates" 86 | }, 87 | { 88 | "name": "documentation", 89 | "color": "#A3C6F9", 90 | "description": "updates or additions to documentation and content" 91 | } 92 | ] 93 | --------------------------------------------------------------------------------