Skip to content

Commit 03cc1be

Browse files
dead-claudiadead-claudia
committed
Add '.github/' from commit '600f3f76b4ec687cc024805b4d3ee47661243a49'
git-subtree-dir: .github git-subtree-mainline: ebb550d git-subtree-split: 600f3f7
2 parents ebb550d + 600f3f7 commit 03cc1be

14 files changed

+539
-0
lines changed

‎.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @MithrilJS/Committers
2+
/.github/ @MithrilJS/Admins

‎.github/ISSUE_TEMPLATE/0-docs.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: '📃 Documentation Issue'
2+
description: Report an issue with Mithril.js's documentation
3+
assignees: dead-claudia
4+
labels:
5+
- 'Area: Documentation'
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Offending URL
17+
description: Provide a link to the page with the issue
18+
placeholder: https://mithril.js.org/
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Issue description
24+
description: What is the precise issue with it. Please be specific.
25+
validations:
26+
required: true

‎.github/ISSUE_TEMPLATE/1-core.yml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: '🐛 Framework Bug'
2+
description: Report a bug in Mithril.js core
3+
assignees: dead-claudia
4+
labels:
5+
- 'Area: Core'
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Mithril.js Version
17+
description: |
18+
Provide the exact version of Mithril.js you're experiencing these issues with. This
19+
matters, even if it's really old like version 0.1.0. Do note that bugs in older
20+
versions are commonly fixed in newer versions, so you should try to test it
21+
against the latest version if you can.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Browser and OS
27+
description: |
28+
Provide the name and version of both the browser and operating system you're
29+
experiencing these issues with. If it's multiple, feel free to list multiple.
30+
This matters, even if it's super ancient.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Project
36+
description: |
37+
(Optional) Provide a link to your project, if it happens to be open source or if
38+
you created a repo somewhere that we can look into further. If it's spread across
39+
multiple repos or projects, feel free to list them all.
40+
- type: textarea
41+
attributes:
42+
label: Code
43+
description: |
44+
What did you try? What code is causing the unexpected behavior? Make sure to
45+
try to reduce your code as best as you can while still reproducing the bug, so
46+
we can more accurately determine the cause. Ideally, it should just be a bunch
47+
of Mithril.js calls with virtually no logic at all, but it's sufficient to just
48+
remove unrelated network calls, attributes, and the like.
49+
50+
In addition, make sure the bug still persists with the latest version of
51+
Mithril. If it's an older version, the bug may have already been fixed.
52+
53+
If you'd prefer, replace this code block with a link to a code playground like
54+
any of these:
55+
56+
- Flems <https://flems.io/mithril> (stores everything in URL hash)
57+
- JSFiddle <https://jsfiddle.net>
58+
- CodePen <https://codepen.io>
59+
- JSBin <https://jsbin.com>
60+
- Plunker <https://plnkr.co>
61+
- Glitch <https://glitch.com> (supports backend)
62+
- CodeSandbox <https://codesandbox.io> (supports backend)
63+
64+
Or if it's a remote development project on your own server, feel free to provide
65+
that if it's serving unminified code we can look at.
66+
67+
If it's a closed-source repo, it's okay to censor names and pull out irrelevant
68+
logic - we'd rather not sign NDAs just to see the code you're having trouble
69+
with. We do still need code of some kind that triggers the bug you're running
70+
into.
71+
render: javascript
72+
validations:
73+
required: true
74+
- type: textarea
75+
attributes:
76+
label: Steps to Reproduce
77+
description: |
78+
What steps need to be taken to reproduce this behavior? Please include things
79+
like specific data that need typed in, specific buttons that need clicked, and
80+
so on.
81+
placeholder: |
82+
1.
83+
2.
84+
3.
85+
4.
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Expected Behavior
91+
description: |
92+
What did you expect to happen?
93+
94+
- An alert to pop up?
95+
- A specific thing to be logged?
96+
97+
Please be very specific here.
98+
validations:
99+
required: true
100+
- type: textarea
101+
attributes:
102+
label: Observed Behavior
103+
description: |
104+
What actually happened?
105+
106+
- The alert never showed?
107+
- The wrong thing was logged?
108+
109+
Please be very specific here.
110+
validations:
111+
required: true
112+
- type: textarea
113+
attributes:
114+
label: Context
115+
description: |
116+
(Optional) How is this issue affecting you? What are you trying to do? Providing
117+
us context helps us reach a solution that best fits your particular needs.

‎.github/ISSUE_TEMPLATE/2-stream.yml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: '🌊 Mithril.js Streams bug'
2+
description: Report an issue with Mithril.js's Streams module
3+
assignees: dead-claudia
4+
labels:
5+
- 'Area: Stream'
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Mithril.js Version
17+
description: |
18+
Provide the exact version of Mithril.js you're experiencing these issues with. This
19+
matters, even if it's really old like version 0.1.0. Do note that bugs in older
20+
versions are commonly fixed in newer versions, so you should try to test it
21+
against the latest version if you can.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Browser and OS
27+
description: |
28+
Provide the name and version of both the browser and operating system you're
29+
experiencing these issues with. If it's multiple, feel free to list multiple.
30+
This matters, even if it's super ancient.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Project
36+
description: |
37+
(Optional) Provide a link to your project, if it happens to be open source or if
38+
you created a repo somewhere that we can look into further. If it's spread across
39+
multiple repos or projects, feel free to list them all.
40+
- type: textarea
41+
attributes:
42+
label: Code
43+
description: |
44+
What did you try? What code is causing the unexpected behavior? Make sure to
45+
try to reduce your code as best as you can while still reproducing the bug, so
46+
we can more accurately determine the cause. Ideally, it should just be a bunch
47+
of Mithril.js calls with virtually no logic at all, but it's sufficient to just
48+
remove unrelated network calls, attributes, and the like.
49+
50+
In addition, make sure the bug still persists with the latest version of
51+
Mithril. If it's an older version, the bug may have already been fixed.
52+
53+
If you'd prefer, replace this code block with a link to a code playground like
54+
any of these:
55+
56+
- Flems <https://flems.io/mithril> (stores everything in URL hash)
57+
- JSFiddle <https://jsfiddle.net>
58+
- CodePen <https://codepen.io>
59+
- JSBin <https://jsbin.com>
60+
- Plunker <https://plnkr.co>
61+
- Glitch <https://glitch.com> (supports backend)
62+
- CodeSandbox <https://codesandbox.io> (supports backend)
63+
64+
Or if it's a remote development project on your own server, feel free to provide
65+
that if it's serving unminified code we can look at.
66+
67+
If it's a closed-source repo, it's okay to censor names and pull out irrelevant
68+
logic - we'd rather not sign NDAs just to see the code you're having trouble
69+
with. We do still need code of some kind that triggers the bug you're running
70+
into.
71+
render: javascript
72+
validations:
73+
required: true
74+
- type: textarea
75+
attributes:
76+
label: Steps to Reproduce
77+
description: |
78+
What steps need to be taken to reproduce this behavior? Please include things
79+
like specific data that need typed in, specific buttons that need clicked, and
80+
so on.
81+
placeholder: |
82+
1.
83+
2.
84+
3.
85+
4.
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Expected Behavior
91+
description: |
92+
What did you expect to happen?
93+
94+
- An alert to pop up?
95+
- A specific thing to be logged?
96+
97+
Please be very specific here.
98+
validations:
99+
required: true
100+
- type: textarea
101+
attributes:
102+
label: Observed Behavior
103+
description: |
104+
What actually happened?
105+
106+
- The alert never showed?
107+
- The wrong thing was logged?
108+
109+
Please be very specific here.
110+
validations:
111+
required: true
112+
- type: textarea
113+
attributes:
114+
label: Context
115+
description: |
116+
(Optional) How is this issue affecting you? What are you trying to do? Providing
117+
us context helps us reach a solution that best fits your particular needs.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ℹ Questions, Ideas, and Discussions
4+
url: https://github.com/MithrilJS/mithril.js/discussions
5+
about: |
6+
Got a question on how to use Mithril.js? Have a fancy idea of how we could do better? Check
7+
out our discussions forum!
8+
- name: ℹ Show and Tell
9+
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=show-and-tell
10+
about: |
11+
Got something to show off? Made something so cool, you just have to tell the world? Let us
12+
know here in our discussions forum!
13+
- name: 🚀 Feature Request or Enhancement
14+
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=ideas
15+
about: Got a feature request? Let us know here! We do those in our discussion forum.
16+
- name: 💻 Zulip Chat
17+
url: https://mithril.zulipchat.com/
18+
about: Not sure about something? Just want to hang out? Come over to our Zulip chat!

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Motivation and Context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
9+
10+
## How Has This Been Tested?
11+
<!--- Please describe in detail how you tested your changes. -->
12+
<!--- Include details of your testing environment, and the tests you ran to -->
13+
<!--- see how your change affects other areas of the code, etc. -->
14+
15+
## Types of changes
16+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
20+
- [ ] Documentation change
21+
22+
## Checklist:
23+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
24+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
25+
- [ ] My code follows the code style of this project.
26+
- [ ] My change requires a change to the documentation.
27+
- [ ] I have updated the documentation accordingly.
28+
- [ ] I have read the **CONTRIBUTING** document.
29+
- [ ] I have added tests to cover my changes.
30+
- [ ] All new and existing tests passed.
31+
- [ ] I have updated `docs/changelog.md`

‎.github/workflows/_npm-task.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Run npm task
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
task:
7+
type: string
8+
required: true
9+
node-version:
10+
type: number
11+
default: 20
12+
continue-on-error:
13+
type: boolean
14+
default: false
15+
16+
permissions:
17+
contents: read
18+
19+
# This uses actions/checkout instead of `git clone` directly since it's way
20+
# easier than parsing everything out.
21+
22+
jobs:
23+
run-task:
24+
name: npm run ${{ inputs.task }}
25+
continue-on-error: ${{ inputs.continue-on-error }}
26+
runs-on:
27+
- ubuntu-latest
28+
- windows-latest
29+
- macos-latest
30+
steps:
31+
- uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 1
34+
- uses: actions/setup-node@v4
35+
with:
36+
node-version: ${{ inputs.node-version }}
37+
- run: npm ci
38+
- run: npm run ${{ inputs.task }}

‎.github/workflows/_post-comment.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Post comment
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
url:
7+
type: string
8+
required: true
9+
message:
10+
type: string
11+
required: true
12+
13+
jobs:
14+
notify:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- run: gh issue comment "$ISSUE_URL" --body "$MESSAGE"
18+
env:
19+
ISSUE_URL: ${{ inputs.url }}
20+
MESSAGE: ${{ inputs.message }}
21+
GITHUB_TOKEN: ${{ github.token }}

‎.github/workflows/issue-create.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Ping triage on issue create
2+
on:
3+
issues:
4+
types: [opened]
5+
permissions:
6+
issues: write
7+
repository-projects: write
8+
jobs:
9+
add_triage:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- run: gh issue edit "$ISSUE_URL" --add-project 'Triage/bugs'
13+
env:
14+
ISSUE_URL: ${{ github.event.issue.url }}
15+
GITHUB_TOKEN: ${{ github.token }}
16+
17+
notify:
18+
uses: ./.github/workflows/_post-comment.yml
19+
with:
20+
url: ${{ github.event.issue.url }}
21+
message: '@MithrilJS/triage Please take a look.'

0 commit comments

Comments
 (0)