Skip to content

Commit eb01020

Browse files
bsmthbsmth
authored
chore: Improvements to template files, formatter config (mdn#173)
* chore: Improvements to template files, formatter config * chore: add contrib doc * chore: add contrib doc * chore(style): Newlines at EOF per reviewer comments
1 parent 6fcc513 commit eb01020

File tree

34 files changed

+342
-91
lines changed

34 files changed

+342
-91
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 2
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.github/CODEOWNERS‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# This file is used to request PR reviews from the appropriate team.
2+
#
3+
# Order is important; the last matching pattern takes precedence.
4+
# Each rule is more specific than the previous rules.
5+
# For more information, see:
6+
# https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-code-owners
7+
8+
# Default
9+
* @mdn/core-yari-content

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "Issue report"
2+
description: Report an unexpected problem or unintended behavior.
3+
labels: ["needs triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### Before you start
9+
10+
**Want to fix the problem yourself?** This project is open source and we welcome fixes and improvements from the community!
11+
12+
↩ Check the project [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) guide to see how to get started.
13+
14+
---
15+
- type: textarea
16+
id: problem
17+
attributes:
18+
label: What was incorrect, unhelpful, or incomplete?
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: expected
23+
attributes:
24+
label: What did you expect to see?
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: references
29+
attributes:
30+
label: Do you have any supporting links, references, or citations?
31+
description: Link to information that helps us confirm your issue.
32+
- type: textarea
33+
id: more-info
34+
attributes:
35+
label: Do you have anything more you want to share?
36+
description: For example, steps to reproduce, screenshots, screen recordings, or sample code.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: MDN GitHub Discussions
4+
url: https://github.com/orgs/mdn/discussions
5+
about: Does the issue involve a lot of pages, or are you not sure how it can be split into actionable tasks? Consider starting a discussion first.
6+
- name: MDN Web Docs on Discourse
7+
url: https://discourse.mozilla.org/c/mdn/learn/250
8+
about: Need help with assessments on MDN Web Docs? We have a support community for this purpose on Discourse.
9+
- name: Help with code
10+
url: https://stackoverflow.com/
11+
about: If you are stuck and need help with code, StackOverflow is a great resource.

‎.github/PULL_REQUEST_TEMPLATE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- 🙌 Thanks for contributing to MDN Web Docs. Adding details below will help us to merge your PR faster. -->
2+
3+
**Description:**
4+
5+
<!-- ✍️ Summarize your changes in one or two sentences -->
6+
7+
**Motivation:**
8+
9+
<!-- ❓ Why are you making these changes and how do they help readers? -->
10+
11+
**Additional details:**
12+
13+
<!-- 🔗 Link to release notes, vendor docs, bug trackers, source control, or other places providing more context -->
14+
15+
**Related issues and pull requests:**
16+
17+
<!-- 🔨 If this fully resolves a GitHub issue, use "Fixes #123" -->
18+
<!-- 👉 Highlight related pull requests using "Relates to #123" -->
19+
<!-- ❗ If another pull request should be merged first, use "**Depends on:** #123" -->
20+
21+
<!-- 👷‍♀️ After submitting, go to the "Checks" tab of your PR for the build status -->

‎.github/workflows/idle-issues.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: "Mark issues and pull requests as idle"
2+
on:
3+
schedule:
4+
- cron: "49 11,23 * * *"
5+
6+
jobs:
7+
idle:
8+
uses: mdn/workflows/.github/workflows/idle.yml@main
9+
with:
10+
target-repo: "mdn/css-examples"

‎.github/workflows/lock-closed.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: "Lock old issues and pull requests"
2+
on:
3+
schedule:
4+
- cron: "0 9 1 * *"
5+
6+
jobs:
7+
lock:
8+
uses: mdn/workflows/.github/workflows/lock-closed.yml@main
9+
with:
10+
target-repo: "mdn/css-examples"

‎.github/workflows/new-issues.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: "Mark new issues with needs-triage label"
2+
3+
on:
4+
issues:
5+
types:
6+
- reopened
7+
- opened
8+
9+
jobs:
10+
label-new-issues:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: initial labelling
14+
uses: andymckay/labeler@master
15+
with:
16+
add-labels: "needs triage"
17+
ignore-if-assigned: true

‎.github/workflows/pr-merge-conflicts.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Label PRs with conflicts"
2+
3+
on:
4+
push:
5+
pull_request_target:
6+
types: [synchronize]
7+
8+
jobs:
9+
label-merge-conflicts:
10+
uses: mdn/workflows/.github/workflows/pr-rebase-needed.yml@main
11+
with:
12+
target-repo: "mdn/css-examples"
13+
secrets:
14+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.markdownlint-cli2.jsonc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"config": {
3+
"extends": "./.markdownlint.jsonc"
4+
},
5+
"ignores": [
6+
"node_modules",
7+
".git",
8+
".github",
9+
"tests",
10+
"editable-samples/codemirror"
11+
]
12+
}

0 commit comments

Comments
 (0)