Skip to content

Commit

Permalink
chore: add CLA, and templates for issues and pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
lowlighter committed Oct 28, 2024
1 parent aeea6a4 commit 165dc61
Show file tree
Hide file tree
Showing 5 changed files with 144 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor License Agreement

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:

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
your contributions and such derivative works.

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
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
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
licenses granted to that entity under this agreement for that contribution shall terminate as of the date such litigation is filed.

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
your employer has waived such rights for your contributions to this project.

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
the right to submit it under the terms of this agreement.

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
feedback on your contribution.

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
are not required to provide support for your contributions.

By submitting your contribution, you agree to the terms and conditions of this Contributor License Agreement.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 🐛 Bug Report
description: File a bug report.
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug!
- type: input
id: scope
attributes:
label: Scope
description: What part of the project does this issue affect?
placeholder: Describe the scope of the issue.
validations:
required: true
- type: textarea
id: report
attributes:
label: What happened?
description: Describe the issue and what you expected to happen.
placeholder: Provide a detailed description of the bug.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Paste any relevant log output here.
render: shell
validations:
required: true
- type: checkboxes
id: environment
attributes:
label: Environment
description: Select the environment(s) where you encountered the issue.
options:
- label: Chromium-based
- label: Firefox
- label: Safari
- label: Node.js
- label: Deno
- label: Bun
- label: Other
validations:
required: true
- type: checkboxes
id: searched
attributes:
label: I have searched for existing issues
description: Have you checked for existing issues that may already cover this request?
options:
- label: "Yes"
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: ✨ Feature Request
description: Request a new feature.
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a feature!
- type: input
id: scope
attributes:
label: Scope
description: What part of the project does this issue affect?
placeholder: Describe the scope of the issue.
validations:
required: true
- type: textarea
id: request
attributes:
label: What do you want to happen?
description: Describe the feature you would like to see added.
placeholder: Provide a detailed description of the feature.
validations:
required: true
- type: textarea
id: references
attributes:
label: Prior Art
description: Are there any examples of this feature in other projects?
placeholder: Provide links to any relevant resources.
validations:
required: true
- type: checkboxes
id: searched
attributes:
label: I have searched for existing issues
description: Have you checked for existing issues that may already cover this request?
options:
- label: "Yes"
required: true
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--
👋 Hi there!
Thank you for helping us improve!
Please make sure to:
- Read CONTRIBUTING.md
- Ensure your pull request is not a duplicate
- Provide a clear and concise description of your changes
- Add tests to cover your changes
- Make sure all checks pass before requesting a review
> [!IMPORTANT]
> By submitting this pull request, you agree to the terms of the Contributor License Agreement:
> https://github.com/lowlighter/mizu/blob/main/.github/CLA.md
Happy coding! 🐕
-->

0 comments on commit 165dc61

Please sign in to comment.