Skip to content

Commit

Permalink
chore: Add Issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sorairolake committed Sep 5, 2024
1 parent e07f602 commit e1371be
Show file tree
Hide file tree
Showing 7 changed files with 141 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# SPDX-FileCopyrightText: 2024 Shun Sakai
#
# SPDX-License-Identifier: CC0-1.0

name: 🐞 Bug report
description: Create a report to help us improve
labels: ["bug"]

body:
- type: checkboxes
attributes:
label: Checklist
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false

- type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sorairolake/japanese-era-dataset/blob/develop/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# SPDX-FileCopyrightText: 2024 Shun Sakai
#
# SPDX-License-Identifier: CC0-1.0

name: 💡 Feature request
description: Suggest an idea for this project
labels: ["enhancement"]

body:
- type: checkboxes
attributes:
label: Checklist
options:
- label: I have searched the existing issues
required: true

- type: textarea
attributes:
label: Summary
description: A clear and concise description of what the suggestion is.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature request here.
validations:
required: false

- type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sorairolake/japanese-era-dataset/blob/develop/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ updates:
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Description

<!-- Describe your changes in detail. -->

<!--
If it resolves an open issue, link to the issue here, otherwise remove this
line.
-->

Closes #

## Additional context

<!-- If you have any other context, describe them here. -->

## Checklist

- [ ] I have read the [Contribution Guide].
- [ ] I agree to follow the [Code of Conduct].

[Contribution Guide]: https://github.com/sorairolake/japanese-era-dataset/blob/develop/CONTRIBUTING.adoc
[Code of Conduct]: https://github.com/sorairolake/japanese-era-dataset/blob/develop/CODE_OF_CONDUCT.md
3 changes: 3 additions & 0 deletions .github/pull_request_template.md.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2024 Shun Sakai

SPDX-License-Identifier: CC0-1.0
1 change: 1 addition & 0 deletions .github/workflows/REUSE.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:
pull_request:
push:
branches:
- "develop"
- "master"

jobs:
Expand Down
36 changes: 36 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// SPDX-FileCopyrightText: 2024 Shun Sakai
//
// SPDX-License-Identifier: CC0-1.0

= Contribution Guide
:git-flow-url: https://nvie.com/posts/a-successful-git-branching-model/
:commit-messages-guide-url: https://github.com/RomuloOliveira/commit-messages-guide
:conventionalcommits-url: https://www.conventionalcommits.org/en/v1.0.0/

Thank you for your interest in contributing to this project! If you would like
to contribute to this project, please follow the instructions below if possible.

== Branching model

The branching model of this project is based on the {git-flow-url}[git-flow].

== Style guides

=== Commit message

Please see the {commit-messages-guide-url}[Commit messages guide] and the
{conventionalcommits-url}[Conventional Commits].

== Submitting a pull request

. Create a working branch from the `develop` branch. The branch name should be
something other than `develop` or `master`.
. Create your patch. If your change is a feature or a bugfix, please add a test
case if possible. Note that the change must pass the CI.
. Please update the copyright information if possible. This project is
compliant with version 3.2 of the
https://reuse.software/spec/[_REUSE Specification_].
https://github.com/fsfe/reuse-tool[`reuse`] is useful for updating the
copyright information.
. Please update the link:CHANGELOG.adoc[Changelog] if possible.
. Please read and agree to follow the link:CODE_OF_CONDUCT.md[Code of Conduct].

0 comments on commit e1371be

Please sign in to comment.