-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit af346b9
Showing
18 changed files
with
1,148 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# This file is used to request PR reviews from the appropriate team. | ||
# | ||
# Order is important; the last matching pattern takes precedence. | ||
# Each rule is more specific than the previous rules. | ||
# For more information, see: | ||
# https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-code-owners | ||
|
||
# Default | ||
* @mdn/core-yari-content |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- 🙌 Thanks for contributing! Adding details below will help us to merge your PR faster. --> | ||
|
||
**Description:** | ||
|
||
<!-- ✍️ Summarize your changes in one or two sentences --> | ||
|
||
**Motivation:** | ||
|
||
<!-- ❓ Why are you making these changes and how do they help? --> | ||
|
||
**Additional details:** | ||
|
||
<!-- 🔗 Link to documentation, bug trackers, source control, or other places providing more context --> | ||
|
||
**Related issues and pull requests:** | ||
|
||
<!-- 🔨 If this fully resolves a GitHub issue, use "Fixes #123" --> | ||
<!-- 👉 Highlight related pull requests using "Relates to #123" --> | ||
<!-- ❗ If another pull request should be merged first, use "**Depends on:** #123" --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Deploying static content to GitHub Pages | ||
# See https://github.com/actions/starter-workflows/blob/main/pages/static.yml | ||
name: Deploy static content | ||
|
||
on: | ||
push: | ||
branches: main | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup Pages | ||
uses: actions/configure-pages@v5 | ||
|
||
# We don't want the whole repo, only select directories: | ||
- name: Prepare assets | ||
run: | | ||
mkdir -p output_dir | ||
cp -r audio fonts images misc videos output_dir/ | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: output_dir | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/shared-assets" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/shared-assets" | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Code of conduct | ||
|
||
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/). | ||
|
||
## 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
# Contribution guide | ||
|
||
![github-profile](https://user-images.githubusercontent.com/10350960/166113119-629295f6-c282-42c9-9379-af2de5ad4338.png) | ||
|
||
- [Ways to contribute](#ways-to-contribute) | ||
- [Finding an issue](#finding-an-issue) | ||
- [Asking for help](#asking-for-help) | ||
- [Pull request process](#pull-request-process) | ||
- [Setting up the development environment](#setting-up-the-development-environment) | ||
- [Forking and cloning the project](#forking-and-cloning-the-project) | ||
- [Prerequisites](#prerequisites) | ||
- [Signing commits](#signing-commits) | ||
|
||
Welcome 👋 Thank you for your interest in contributing to MDN Web Docs. We are happy to have you join us! 💖 | ||
|
||
As you get started, you are in the best position to give us feedback on project areas we might have forgotten about or assumed to work well. | ||
These include, but are not limited to: | ||
|
||
- Problems found while setting up a new developer environment | ||
- Gaps in our documentation | ||
- Bugs in our automation scripts | ||
|
||
If anything doesn't make sense or work as expected, please open an issue and let us know! | ||
|
||
## Ways to contribute | ||
|
||
We welcome many different types of contributions including: | ||
|
||
<!-- TODO: These are not set in stone and should be reconsidered per project based on needs. --> | ||
|
||
- New features and content suggestions. | ||
- Identifying and filing issues. | ||
- Providing feedback on existing issues. | ||
- Engaging with the community and answering questions. | ||
- Contributing documentation or code. | ||
- Promoting the project in personal circles and social media. | ||
|
||
## Finding an issue | ||
|
||
We have issues labeled `good first issue` for new contributors and `help wanted` suitable for any contributor. | ||
Good first issues have extra information to help you make your first contribution a success. | ||
Help wanted issues are ideal when you feel a bit more comfortable with the project details. | ||
|
||
Sometimes there won't be any issues with these labels, but there is likely still something for you to work on. | ||
If you want to contribute but don't know where to start or can't find a suitable issue, speak to us on [Matrix](https://matrix.to/#/#mdn:mozilla.org), and we will be happy to help. | ||
|
||
Once you find an issue you'd like to work on, please post a comment saying you want to work on it. | ||
Something like "I want to work on this" is fine. | ||
Also, mention the community team using the `@mdn/mdn-community-engagement` handle to ensure someone will get back to you. | ||
|
||
## Asking for help | ||
|
||
The best way to reach us with a question when contributing is to use the following channels in the following order of precedence: | ||
|
||
- [Start a discussion](https://github.com/orgs/mdn/discussions) | ||
- Ask your question or highlight your discussion on [Matrix](https://matrix.to/#/#mdn:mozilla.org). | ||
- File an issue and tag the community team using the `@mdn/mdn-community-engagement` handle. | ||
|
||
## Pull request process | ||
|
||
The MDN Web Docs project has a well-defined pull request process which is documented in the [Pull request guidelines](https://developer.mozilla.org/en-US/docs/MDN/Community/Pull_requests). | ||
Make sure you read and understand this process before you start working on a pull request. | ||
|
||
## Setting up the development environment | ||
|
||
<!-- TODO --> | ||
|
||
### Forking and cloning the project | ||
|
||
The first step in setting up your development environment is to [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and [clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) the repository to your local machine. | ||
|
||
<!-- | ||
TODO | ||
### Prerequisites | ||
A section here that describes the steps needed to prepare a local machine before building. | ||
It should look like this: | ||
To get started, make sure you have the following: | ||
- [NVM](https://github.com/nvm-sh/nvm) or [NVM for Windows](https://github.com/coreybutler/nvm-windows) | ||
- [Nodejs](https://nodejs.org/en/) (Latest stable release or up to two versions back) | ||
### Building the project | ||
Add a section here that describes the steps needed to build this project. | ||
It should follow the same structure as the following example: | ||
Once you have the above installed and have the repository cloned, it is time to install the project dependencies. | ||
```bash | ||
npm i | ||
``` | ||
With the dependencies installed you can start the project with the following command: | ||
```bash | ||
npm start | ||
``` | ||
Open `http://localhost:3000` in your browser. | ||
To run the test suite, use the following command: | ||
```bash | ||
npm test | ||
``` | ||
--> | ||
|
||
## Signing commits | ||
|
||
We require all commits to be signed to verify the author's identity. | ||
GitHub has a detailed guide on [setting up signed commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). | ||
If you get stuck, please [ask for help](#asking-for-help). |
Oops, something went wrong.