-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
167 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
name: "Bug report 🐛" | ||
description: Report an issue, bug or unexpected behaviour | ||
labels: [bug] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! 🙏 | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the bug 📝 | ||
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! | ||
placeholder: | | ||
I am doing ... | ||
What I expect is ... | ||
What is actually happening is... | ||
validations: | ||
required: true | ||
- type: input | ||
id: reproduction | ||
attributes: | ||
label: Reproduction ▶️ | ||
description: If possible, please provide an [asciinema record](https://asciinema.org/) or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is desirable. If a report is vague (e.g. just a generic error message) and has no reproduction, solving it will also be a slower or unfeasible process. | ||
placeholder: Reproduction URL | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: reproduction-steps | ||
attributes: | ||
label: Steps to reproduce 🔢 | ||
description: Please provide any reproduction steps that may need to be described. | ||
placeholder: | | ||
1. Run `npm install`. | ||
2. ... | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: system-info | ||
attributes: | ||
label: System Info 💻 | ||
description: Output of `npx envinfo --system --npmPackages 'openbim-components' --binaries --browsers` | ||
render: shell | ||
placeholder: System, Binaries, Browsers | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: package-manager | ||
attributes: | ||
label: Used Package Manager 📦 | ||
description: Select the used package manager | ||
options: | ||
- npm | ||
- yarn | ||
- pnpm | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Error Trace/Logs 📃 | ||
description: | | ||
Optional if provided reproduction. Please try not to insert an image but copy paste the error trace/logs text. | ||
Provide the error log here in the format below: | ||
```` | ||
<details> | ||
<summary>Click to expand!</summary> | ||
```shell | ||
// paste the log text here | ||
``` | ||
</details> | ||
```` | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations ✅ | ||
description: "Before submitting the issue, please make sure that you have:" | ||
options: | ||
- label: Read the [docs](https://platform.thatopen.com/documentation). | ||
required: true | ||
- label: Check that there isn't [already an issue](https://github.com/IFCjs/clay/issues) that reports the same bug to avoid creating a duplicate. | ||
required: true | ||
- label: Make sure this is a repository issue and not a framework-specific issue. For example, if it's a THREE.js related bug, it should likely be reported to [mrdoob/threejs](https://github.com/mrdoob/three.js) instead. | ||
required: true | ||
- label: Check that this is a concrete bug. For Q&A join our [Community](https://people.thatopen.com/). | ||
required: true | ||
- label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
contact_links: | ||
- name: Community | ||
url: https://people.thatopen.com/ | ||
about: Join the community and discuss with other BIM software developers in real time. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: "New feature proposal 🚀" | ||
description: Propose a new feature or cool thing | ||
labels: [feature] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! 🙏 | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Description 📝 | ||
description: "Clear and concise description of the problem. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks!" | ||
placeholder: "Example: As a BIM developer/engineer using IFC.js I want [goal / wish] so that [benefit]." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-solution | ||
attributes: | ||
label: Suggested solution 💡 | ||
description: If possible, include in this field a solution or approach that would solve or implement the described feature. | ||
placeholder: "In module/component [xy] we could provide the following implementation..." | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: alternative | ||
attributes: | ||
label: Alternative ⛕ | ||
description: Clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context ☝️ | ||
description: Any other context or screenshots about the feature request here. | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations ✅ | ||
description: "Before submitting the issue, please make sure that you have:" | ||
options: | ||
- label: Read the [docs](https://platform.thatopen.com/documentation). | ||
required: true | ||
- label: Check that there isn't [already an issue](https://github.com/IFCjs/clay/issues) that requests the same feature to avoid creating a duplicate. | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Thanks you so much for your PR, your contribution is appreciated! ❤️ --> | ||
|
||
### Description | ||
|
||
<!-- Please insert your description here. Make sure to provide info about the "what" this PR is solving --> | ||
|
||
### Additional context | ||
|
||
<!-- e.g. is there anything you'd like reviewers to focus on? --> | ||
|
||
--- | ||
|
||
### What is the purpose of this pull request? <!-- (put an "X" next to an item) --> | ||
|
||
- [ ] Bug fix | ||
- [ ] New Feature | ||
- [ ] Documentation update | ||
- [ ] Other | ||
|
||
### Before submitting the PR, please make sure you do the following: | ||
|
||
- [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate. | ||
- [ ] Follow the [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) standard for PR naming (e.g. `feat(examples): add hello-world example`). | ||
- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`). | ||
- [ ] Ideally, include relevant tests that fail without this PR but pass with it. |