Skip to content

Commit

Permalink
docs(): update guides (#8189)
Browse files Browse the repository at this point in the history

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Steve Eberhardt <melchiar2@gmail.com>
Co-authored-by: Andrea Bogazzi <andreabogazzi79@gmail.com>
  • Loading branch information
4 people committed Oct 17, 2022
1 parent a1f5288 commit 6414077
Show file tree
Hide file tree
Showing 11 changed files with 522 additions and 363 deletions.
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

131 changes: 131 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
name: 🐛 Bug Report
description: File a bug report
title: '[Bug]: '
body:
- type: markdown
attributes:
value: >
Thank you for wanting to create an issue in this repository.
Before you do, please ensure you are filing the issue in the right
place.
* If you have a question or if an issue is not right for what you mean
to file use
[Discussions](https://github.com/fabricjs/fabric.js/discussions).
- type: checkboxes
id: terms
attributes:
label: CheckList
description: >-
By submitting this issue, you agree to follow our [Code of
Conduct](https://github.com/fabricjs/fabric.js/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- label: >-
I have read and followed the [Contributing
Guide](https://github.com/fabricjs/fabric.js/CONTRIBUTING.md)
required: true
- label: >-
I have read and followed the [Issue Tracker
Guide](https://github.com/fabricjs/fabric.js/CONTRIBUTING.md#%EF%B8%8F-issue-tracker)
required: true
- label: I have searched and referenced existing issues and discussions
required: true
- label: I am filing a **BUG** report.
required: true
- label: >-
I have managed to reproduce the bug **after** upgrading to the
**latest** version
required: true
- label: I have created an accurate and minimal reproduction
required: true
- type: dropdown
id: _version
attributes:
label: Version
description: >-
If you are working on a version below latest you should upgrade to
latest before filing a bug report, your issue might have been resolved
already.
options:
validations:
required: true
- type: dropdown
id: environments
attributes:
label: In What environments are you experiencing the problem?
description: >-
checkout the [supported
browsers](/README.md#supported-browsersenvironments)
multiple: true
options:
- Firefox
- Chrome
- Safari
- Opera
- Microsoft Edge
- Node.js
- type: dropdown
id: _node_version
attributes:
label: Node Version (if applicable)
description: Provide the version if the bug occurs in Node.js
options:
validations:
required: false
- type: input
id: reproduction_link
attributes:
label: Link To Reproduction
description: >
A good reproduction helps us UNDERSTAND your issue, find the bug and fix
it quickly.
Take the time and put effort into making your reproduction accurate and
minimal.
Use the following reproduction templates.
- [Browser reproduction template](https://jsfiddle.net/Lcp2h3nv/)
- [Node reproduction
template](https://codesandbox.io/s/exciting-browser-ytb701)
⛔ No reproduction === closed issue ⛔
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps To Reproduce
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: Provide screenshots/screencasts if relevant
validations:
required: true
- type: textarea
id: error
attributes:
label: Error Message & Stack Trace
description: Provide logging outputs/errors if relevant
render: bash
validations:
required: false
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

blank_issues_enabled: false
contact_links:
- name: Discussions
url: ./discussions
about: Please ask and answer questions here.
- name: GOTCHAS
url: http://fabricjs.com/fabric-gotchas
about: Refer to the list of known pitfalls before assuming a bug.
- name: Security
url: ./Security.md
about: Please report security vulnerabilities here.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ about: Creating a PR
<!--
Hi there!
Thanks for taking the time and putting the effort into making fabric better! 💖
Take a look at ./CONTRIBUTING.md for crucial instructions regarding local setup, testing etc.
Take a look at /CONTRIBUTING.md for crucial instructions regarding local setup, testing etc.
https://github.com/fabricjs/fabric.js/blob/master/CONTRIBUTING.md
Adding tests that verify your fix and safegurad it from unwanted loss and changes is a MUST.
Expand Down
32 changes: 32 additions & 0 deletions .github/workflows/npmpublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,35 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
PRE_RELEASE: ${{github.event.release.prerelease}}
update-bug-report:
runs-on: ubuntu-latest
# wait for publishing to complete
needs: publish-npm
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.release.target_commitish }}
- name: Update bug report version
uses: ShaMan123/gha-populate-form-version@v2.0.1
with:
semver: '>=4.0.0 || >=6.0.0-rc'
dry_run: no-push
- name: Update bug report node version
uses: ShaMan123/gha-populate-form-version@v2.0.1
with:
dropdown: _node_version
package: node
semver: '>=14.0.0'
dry_run: no-push
- name: Commit & PR
uses: peter-evans/create-pull-request@v4.1.3
with:
add-paths: .github/ISSUE_TEMPLATE/bug_report.yml
branch: ci-update-bug-report
base: ${{ needs.pre.outputs.branch }}
delete-branch: true
labels: CI/CD, bot, task
title: 'chore(): Update bug report'
body: |
Automated update to `.github/ISSUE_TEMPLATE/bug_report.yml`
Triggered by job [`${{ github.job }}`](../actions/runs/${{ github.run_id }})
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
*.iml
change-output.md
/.nyc_output/
/.vscode/
/node_modules/
/npm-debug.log
before_commit
Expand Down
1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
*.iml
change-output.md
/.nyc_output/
/.vscode/
/node_modules/
/npm-debug.log
before_commit
Expand Down
12 changes: 12 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"markdown.validate.enabled": true,
"markdown.validate.fileLinks.enabled": "warning",
"markdown.validate.fragmentLinks.enabled": "warning",
"markdown.validate.fileLinks.markdownFragmentLinks": "warning",
"markdown.validate.referenceLinks.enabled": "warning",
"markdown.validate.ignoredLinks": [
// github links
"../../**"
]
}
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## [next]

- docs(): refactor guides, bug report template [#8189](https://github.com/fabricjs/fabric.js/pull/8189)
- BREAKING fix(polyline/polygon): stroke bounding box for all line join/cap cases [#8344](https://github.com/fabricjs/fabric.js/pull/8344)
BREAKING: `_setPositionDimensions` was removed in favor of `setDimensions`
- test(): Added 2 tests for polygon shapes and transforms with translations [#8370](https://github.com/fabricjs/fabric.js/pull/8370)
Expand Down
Loading

0 comments on commit 6414077

Please sign in to comment.