Skip to content

Commit 165dc61

Browse files
committed
chore: add CLA, and templates for issues and pull requests
1 parent aeea6a4 commit 165dc61

File tree

5 files changed

+144
-0
lines changed

5 files changed

+144
-0
lines changed

.github/CLA.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributor License Agreement
2+
3+
By making a contribution to this project, you agree to the following terms and conditions for your present and future contributions submitted to this project. In return, the project maintainers shall consider your contribution for inclusion in the project. You confirm that:
4+
5+
1. **Grant of Rights**: You hereby grant to the project maintainers and the project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to use, reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute
6+
your contributions and such derivative works.
7+
8+
2. **Grant of Patent License**: You hereby grant to the project maintainers and the project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and
9+
otherwise transfer your contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contributions alone or by combination of your contributions with the project to which such contributions were submitted. If
10+
any entity institutes patent litigation against you or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your contribution, or the project to which you have contributed, constitutes direct or contributory patent infringement, then any patent
11+
licenses granted to that entity under this agreement for that contribution shall terminate as of the date such litigation is filed.
12+
13+
3. **Legal Authority**: You represent that you are legally entitled to grant the above licenses. If your employer has rights to intellectual property that you create, you represent that you have received permission to make the contributions on behalf of that employer, or that
14+
your employer has waived such rights for your contributions to this project.
15+
16+
4. **Third-Party Content**: You confirm that any third-party content included in your contributions is permitted to be used by this project and is compatible with the project's license. You have verified that such third-party content is appropriately licensed and that you have
17+
the right to submit it under the terms of this agreement.
18+
19+
5. **No Obligation**: You understand that the decision to include your contribution in the project is entirely at the discretion of the project maintainers and that the project maintainers have no obligation to include your contribution in any project release or to provide any
20+
feedback on your contribution.
21+
22+
6. **Disclaimer**: Your contributions are provided "as is", without warranties or conditions of any kind, either express or implied, including, without limitation, any warranties or conditions of title, non-infringement, merchantability, or fitness for a particular purpose. You
23+
are not required to provide support for your contributions.
24+
25+
By submitting your contribution, you agree to the terms and conditions of this Contributor License Agreement.

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to report a bug!
11+
- type: input
12+
id: scope
13+
attributes:
14+
label: Scope
15+
description: What part of the project does this issue affect?
16+
placeholder: Describe the scope of the issue.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: report
21+
attributes:
22+
label: What happened?
23+
description: Describe the issue and what you expected to happen.
24+
placeholder: Provide a detailed description of the bug.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: logs
29+
attributes:
30+
label: Relevant log output
31+
description: Paste any relevant log output here.
32+
render: shell
33+
validations:
34+
required: true
35+
- type: checkboxes
36+
id: environment
37+
attributes:
38+
label: Environment
39+
description: Select the environment(s) where you encountered the issue.
40+
options:
41+
- label: Chromium-based
42+
- label: Firefox
43+
- label: Safari
44+
- label: Node.js
45+
- label: Deno
46+
- label: Bun
47+
- label: Other
48+
validations:
49+
required: true
50+
- type: checkboxes
51+
id: searched
52+
attributes:
53+
label: I have searched for existing issues
54+
description: Have you checked for existing issues that may already cover this request?
55+
options:
56+
- label: "Yes"
57+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: ✨ Feature Request
2+
description: Request a new feature.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to request a feature!
11+
- type: input
12+
id: scope
13+
attributes:
14+
label: Scope
15+
description: What part of the project does this issue affect?
16+
placeholder: Describe the scope of the issue.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: request
21+
attributes:
22+
label: What do you want to happen?
23+
description: Describe the feature you would like to see added.
24+
placeholder: Provide a detailed description of the feature.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: references
29+
attributes:
30+
label: Prior Art
31+
description: Are there any examples of this feature in other projects?
32+
placeholder: Provide links to any relevant resources.
33+
validations:
34+
required: true
35+
- type: checkboxes
36+
id: searched
37+
attributes:
38+
label: I have searched for existing issues
39+
description: Have you checked for existing issues that may already cover this request?
40+
options:
41+
- label: "Yes"
42+
required: true

.github/pull_request_template.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!--
2+
3+
👋 Hi there!
4+
Thank you for helping us improve!
5+
6+
Please make sure to:
7+
- Read CONTRIBUTING.md
8+
- Ensure your pull request is not a duplicate
9+
- Provide a clear and concise description of your changes
10+
- Add tests to cover your changes
11+
- Make sure all checks pass before requesting a review
12+
13+
> [!IMPORTANT]
14+
> By submitting this pull request, you agree to the terms of the Contributor License Agreement:
15+
> https://github.com/lowlighter/mizu/blob/main/.github/CLA.md
16+
17+
Happy coding! 🐕
18+
19+
-->

0 commit comments

Comments
 (0)