-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into marrionluaka-fix-channel-messaging-type-error
- Loading branch information
Showing
90 changed files
with
3,573 additions
and
2,649 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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,8 @@ | ||
blank_issues_enabled: false | ||
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 your topic involve a lot of pages, or are you not sure how it can be split into actionable tasks? Consider starting a discussion first. |
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,41 @@ | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
# The branches below must be a subset of the branches above | ||
branches: [main] | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze | ||
runs-on: ubuntu-latest | ||
if: github.repository == 'mdn/dom-examples' | ||
permissions: | ||
actions: read | ||
contents: read | ||
security-events: write | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
language: ["javascript"] | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v3 | ||
with: | ||
languages: ${{ matrix.language }} | ||
|
||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
# If this step fails, then you should remove it and run the build manually (see below) | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v3 | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v3 |
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 @@ | ||
name: "Label PRs with conflicts" | ||
|
||
on: | ||
push: | ||
pull_request_target: | ||
types: [synchronize] | ||
|
||
jobs: | ||
label-merge-conflicts: | ||
uses: mdn/workflows/.github/workflows/pr-rebase-needed.yml@main | ||
with: | ||
target-repo: "mdn/dom-examples" | ||
secrets: | ||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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,2 @@ | ||
**/*.html | ||
**/*.md |
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,3 @@ | ||
{ | ||
"bracketSameLine": true | ||
} |
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,55 @@ | ||
# Contribution guide | ||
|
||
The "dom-examples" repository accompany various MDN DOM and Web API documentation pages on [MDN Web Docs](https://developer.mozilla.org). | ||
This document will help you get started with contributions! | ||
|
||
## Types of contribution | ||
|
||
> [!NOTE] | ||
> You can include an example directly in MDN pages using [`{{EmbedLiveSample()}}` macros](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#code_samples) or regular Markdown code blocks. | ||
> These methods are simpler to maintain as the code lives beside the rest of the content. | ||
> Only add examples to this repository if your example doesn't easily run on MDN pages for technical or security reasons. | ||
There are many ways you can help improve this repository! For example: | ||
|
||
- **Write a new example.** If you would like to add a new example, make sure this feature is supported by a stable version of modern browsers. | ||
- **Improve an existing example.** You could make improvements or add some other changes which would make example more helpful to the users. | ||
- **Fix a bug:** we have a list of [issues](https://github.com/mdn/dom-examples/issues), or maybe you found your own. | ||
|
||
## Getting started | ||
|
||
You will need to have Git and GitHub set up to be able to contribute. | ||
|
||
### Set up Git and GitHub | ||
|
||
For more information on setting up Git on your machine, [read this article](https://help.github.com/articles/set-up-git/). | ||
With the above dependencies satisfied, [create your new account on GitHub](https://github.com/join). | ||
|
||
Next up, you need to fork and clone the repo to be able to contribute to it. | ||
You can [learn about forking on GitHub](https://help.github.com/articles/fork-a-repo). | ||
Once you have your own fork, [clone it to your local machine](https://help.github.com/articles/cloning-a-repository/). | ||
|
||
### Serving | ||
|
||
You should serve your example locally to see the results before submitting your changes. | ||
There are a few different ways to do this depending on your preferred tooling methods. | ||
See [Running a simple local HTTP server](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/set_up_a_local_testing_server#running_a_simple_local_http_server) for information on setting up a server. | ||
|
||
```bash | ||
cd my-cool-example | ||
python3 -m http.server | ||
``` | ||
|
||
### Open a pull request | ||
|
||
Once you're satisfied, the final step is to [submit your pull request](https://help.github.com/articles/creating-a-pull-request/). | ||
You can find more information about submitting pull requests in our [Community guidelines](https://developer.mozilla.org/en-US/docs/MDN/Community/Pull_requests) docs. | ||
|
||
### Including your example on MDN | ||
|
||
After your pull request is reviewed and merged, you can publish your example on MDN Web Docs. | ||
|
||
## Thank you | ||
|
||
Thanks a lot for your contribution! | ||
If you'd like to ask questions or get in touch, feel free to drop by in [Discord](https://developer.mozilla.org/discord) or say hello in one of [our communication channels](https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels). |
Oops, something went wrong.