Skip to content

Commit

Permalink
Merge pull request #91 from dojoengine/pr-template
Browse files Browse the repository at this point in the history
Pr template
  • Loading branch information
ponderingdemocritus authored Dec 21, 2023
2 parents c42a109 + ff96233 commit e4ed11d
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 2 deletions.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Bug Report
description: Report a bug
title: "[Bug]: "
labels: ["bug"]
body:
- type: input
id: version
attributes:
label: Dojo.js Version
description: What Dojo.js version are you using?
validations:
required: true

- type: textarea
id: current-behavior
attributes:
label: What happened?
description: Describe the issue here.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: What is the expected behavior?
description: Describe the expected behavior here.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Describe the steps to reproduce the issue here.
validations:
required: true

- type: textarea
id: logs
attributes:
label: Trace
description: Please provide output of the error.
validations:
required: false

- type: checkboxes
id: verified-not-exists
attributes:
label: Is there an existing issue for this?
options:
- label: I have searched the existing issues and verified no issue exits for this problem.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/codebase_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Codebase improvement
description: Feedback on the codebase
title: "[Enhancement]: "
body:
- type: textarea
id: feedback
attributes:
label: Feedback
description: Provide your feedback for the existing codebase.
validations:
required: true

- type: checkboxes
id: contribution
attributes:
label: If the request is accepted, would you be willing to contribute it?
options:
- label: Yes I would be willing to contribute
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Feature request
description: Suggest a feature
title: "[Feature]: "
body:
- type: textarea
id: suggestion
attributes:
label: Feature Request
description: Describe the feature(s) you would like to be added.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe a prefered solution.
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe alternatives.
validations:
required: false

- type: textarea
id: related
attributes:
label: Related Code
description: Link the related code.
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: If relevant, please provide the additional context.
validations:
required: false

- type: checkboxes
id: contribution
attributes:
label: If the feature is accepted, would you be willing to contribute it?
options:
- label: Yes I would be willing to contribute
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 @@
<!-- Reference any GitHub issues resolved by this PR -->

Closes #

## Introduced changes

<!-- A brief description of the changes -->

-

## Checklist

<!-- Make sure all of these are complete -->

- [ ] Linked relevant issue
- [ ] Updated relevant documentation
- [ ] Added relevant tests
- [ ] Add a dedicated CI job for new examples
- [ ] Performed self-review of the code
2 changes: 0 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: "typedoc"
on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read
Expand Down

0 comments on commit e4ed11d

Please sign in to comment.