Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(): update guides #8189

Merged
merged 144 commits into from
Oct 17, 2022
Merged
Show file tree
Hide file tree
Changes from 139 commits
Commits
Show all changes
144 commits
Select commit Hold shift + click to select a range
b641fa8
Update README.md
ShaMan123 Aug 26, 2022
eb27fd6
Create LICENSE.md
ShaMan123 Aug 26, 2022
10be4d7
Update README.md
ShaMan123 Aug 26, 2022
f52628f
Update README.md
ShaMan123 Aug 26, 2022
874ec76
Update README.md
ShaMan123 Aug 26, 2022
e4bafda
Update README.md
ShaMan123 Aug 26, 2022
c840e17
Update README.md
ShaMan123 Aug 26, 2022
e80f10c
Update bug_report.md
ShaMan123 Aug 26, 2022
8144420
Update bug_report.md
ShaMan123 Aug 26, 2022
f36642a
Merge branch 'master' into readme
ShaMan123 Aug 26, 2022
d7c347a
Merge branch 'master' into readme
ShaMan123 Aug 27, 2022
5591a1b
Squashed commit of the following:
ShaMan123 Aug 27, 2022
c0764b7
dep wiki
ShaMan123 Aug 27, 2022
ad0753e
Update CONTRIBUTING.md
ShaMan123 Aug 27, 2022
4cef45d
Update README.md
ShaMan123 Aug 27, 2022
5d8db2f
Update CONTRIBUTING.md
ShaMan123 Aug 27, 2022
36f50a7
Update CONTRIBUTING.md
ShaMan123 Aug 28, 2022
855237d
Update CONTRIBUTING.md
ShaMan123 Aug 28, 2022
c13dfea
Create Gotchas.md
ShaMan123 Aug 28, 2022
5b94617
Revert "Create Gotchas.md"
ShaMan123 Aug 28, 2022
164c90a
Create GOTCHAS.md
ShaMan123 Aug 28, 2022
069b6b3
Update CONTRIBUTING.md
ShaMan123 Aug 28, 2022
f8cb97f
Update README.md
ShaMan123 Aug 28, 2022
e5fb097
Update README.md
ShaMan123 Aug 28, 2022
9524c91
Update GOTCHAS.md
ShaMan123 Aug 28, 2022
136d0e5
Update GOTCHAS.md
ShaMan123 Aug 28, 2022
61d9ce5
Update GOTCHAS.md
ShaMan123 Aug 28, 2022
f6ce88e
Update object_geometry.mixin.ts
ShaMan123 Aug 28, 2022
6040e02
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Aug 28, 2022
0b16270
Update GOTCHAS.md
ShaMan123 Aug 28, 2022
3f3eaf9
Merge branch 'master' into readme
ShaMan123 Aug 30, 2022
6491c4e
Update README.md
ShaMan123 Aug 30, 2022
cc1b68b
Update README.md
ShaMan123 Aug 30, 2022
341a5e3
Update README.md
ShaMan123 Aug 30, 2022
3b79b07
Update README.md
ShaMan123 Aug 30, 2022
90a1a7e
Update README.md
ShaMan123 Aug 30, 2022
38dabda
Update README.md
ShaMan123 Aug 30, 2022
1bc309f
Update GOTCHAS.md
ShaMan123 Sep 2, 2022
1c79acb
Update bug_report.md
ShaMan123 Sep 3, 2022
bc01719
Update bug_report.md
ShaMan123 Sep 3, 2022
da81671
Merge branch 'master' into readme
ShaMan123 Sep 3, 2022
fe60c80
Merge branch 'master' into readme
ShaMan123 Sep 5, 2022
c78c887
Merge branch 'master' into readme
ShaMan123 Sep 11, 2022
4dcdc0e
ci(): vscode settings
ShaMan123 Sep 12, 2022
f55a0dc
Update CONTRIBUTING.md
ShaMan123 Sep 12, 2022
dbf89ce
Update CONTRIBUTING.md
ShaMan123 Sep 12, 2022
2a249b2
Update CONTRIBUTING.md
ShaMan123 Sep 12, 2022
695d2d2
Update CONTRIBUTING.md
ShaMan123 Sep 19, 2022
c3e3e86
Merge branch 'master' into readme
ShaMan123 Sep 19, 2022
5808ea2
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Sep 19, 2022
c7c47d2
Update bug_report.md
ShaMan123 Sep 19, 2022
b42d3a1
fix typo + prettier took control
ShaMan123 Sep 19, 2022
8f66434
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Sep 19, 2022
20af349
Update README.md
ShaMan123 Sep 20, 2022
c4a178f
Update CONTRIBUTING.md
ShaMan123 Sep 20, 2022
0dea20c
Update CONTRIBUTING.md
ShaMan123 Sep 20, 2022
0d46f32
Update CONTRIBUTING.md
ShaMan123 Sep 20, 2022
85538d2
Update CONTRIBUTING.md
ShaMan123 Sep 20, 2022
c9be536
Update README.md
ShaMan123 Sep 20, 2022
34d0090
Update CONTRIBUTING.md
ShaMan123 Sep 20, 2022
74cb7c0
Update README.md
ShaMan123 Sep 22, 2022
73ff932
Update CONTRIBUTING.md
ShaMan123 Sep 22, 2022
06f08e8
Update README.md
ShaMan123 Sep 25, 2022
8a4ded2
Merge branch 'master' into readme
ShaMan123 Sep 28, 2022
0473d60
Create config.yml
ShaMan123 Sep 28, 2022
2080b7b
update bug report
ShaMan123 Sep 28, 2022
43a52c4
Update npmpublish.yml
ShaMan123 Sep 28, 2022
32867a2
Update npmpublish.yml
ShaMan123 Sep 28, 2022
ef84be4
Update npmpublish.yml
ShaMan123 Sep 28, 2022
69e0daa
Revert "Update npmpublish.yml"
ShaMan123 Sep 28, 2022
fbf6c7c
Update npmpublish.yml
ShaMan123 Sep 28, 2022
d312241
Update npmpublish.yml
ShaMan123 Sep 28, 2022
120f479
chore(): update bug report version
github-actions[bot] Sep 28, 2022
3ed98e3
Revert "Update npmpublish.yml"
ShaMan123 Sep 28, 2022
6424d2f
Revert "Update npmpublish.yml"
ShaMan123 Sep 28, 2022
0b271dd
Revert "Update npmpublish.yml"
ShaMan123 Sep 28, 2022
695bd5d
Update npmpublish.yml
ShaMan123 Sep 28, 2022
8c0a906
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Sep 28, 2022
3a74b15
node version
ShaMan123 Sep 28, 2022
3c9e941
Update npmpublish.yml
ShaMan123 Sep 28, 2022
9ed51f6
setup version update
ShaMan123 Sep 30, 2022
75e2b74
Update npmpublish.yml
ShaMan123 Sep 30, 2022
e7af30d
Update npmpublish.yml
ShaMan123 Sep 30, 2022
c771c84
Update npmpublish.yml
ShaMan123 Sep 30, 2022
afb8a57
Update bug_report.yml
ShaMan123 Sep 30, 2022
4fbf758
Update npmpublish.yml
ShaMan123 Sep 30, 2022
322a767
Update npmpublish.yml
ShaMan123 Sep 30, 2022
63dcf93
Update npmpublish.yml
ShaMan123 Sep 30, 2022
7c81cc7
test package
ShaMan123 Sep 30, 2022
42c091a
disable workflow
ShaMan123 Sep 30, 2022
7b7fdcc
Update npmpublish.yml
ShaMan123 Sep 30, 2022
3b22b6f
Revert "disable workflow"
ShaMan123 Sep 30, 2022
c36a258
Revert "Revert "disable workflow""
ShaMan123 Sep 30, 2022
bb9459a
link
ShaMan123 Sep 30, 2022
5cc4184
Revert "Revert "Revert "disable workflow"""
ShaMan123 Sep 30, 2022
8991786
Revert "Revert "Revert "Revert "disable workflow""""
ShaMan123 Sep 30, 2022
efdf982
rephrase
ShaMan123 Oct 13, 2022
232dec0
rephrase(): Apply suggestions from code review
ShaMan123 Oct 13, 2022
0d20011
Update GOTCHAS.md
ShaMan123 Oct 13, 2022
47cfade
Merge branch 'master' into readme
ShaMan123 Oct 13, 2022
9f23a53
render agents
ShaMan123 Oct 13, 2022
b580d21
Gotchas link
ShaMan123 Oct 13, 2022
fa6a899
prettier
ShaMan123 Oct 13, 2022
0f3f500
bye google group
ShaMan123 Oct 13, 2022
129541a
Update CONTRIBUTING.md
ShaMan123 Oct 13, 2022
59685af
contributing rearrange
ShaMan123 Oct 13, 2022
461fd94
refactor contributing
ShaMan123 Oct 13, 2022
9910b9e
Update CONTRIBUTING.md
ShaMan123 Oct 13, 2022
4c83fb3
Update CONTRIBUTING.md
ShaMan123 Oct 13, 2022
fd6797b
style
ShaMan123 Oct 13, 2022
395f6da
Update CHANGELOG.md
ShaMan123 Oct 13, 2022
349546d
rephrase Vanishing Object
ShaMan123 Oct 13, 2022
985d0d1
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Oct 13, 2022
a6da729
Update npmpublish.yml
ShaMan123 Oct 13, 2022
9fc6162
Update npmpublish.yml
ShaMan123 Oct 13, 2022
af12f9e
rvert
ShaMan123 Oct 13, 2022
4f915c2
cleanup
ShaMan123 Oct 13, 2022
c4b0704
Delete GOTCHAS.md
ShaMan123 Oct 13, 2022
24a522b
Delete LICENSE.md
ShaMan123 Oct 15, 2022
9ab66ee
md links
ShaMan123 Oct 15, 2022
84edf38
md links
ShaMan123 Oct 15, 2022
732b4fd
Merge branch 'vscode-settings' into readme
ShaMan123 Oct 15, 2022
6c7bc4b
fix
ShaMan123 Oct 15, 2022
8406aed
vscode settings
ShaMan123 Oct 15, 2022
9b75e48
restore unsupported links
ShaMan123 Oct 15, 2022
6c25207
more link fixes
ShaMan123 Oct 15, 2022
6f2daa7
Update README.md
ShaMan123 Oct 15, 2022
08e13dd
code samples into details
ShaMan123 Oct 15, 2022
8418333
Update README.md
ShaMan123 Oct 15, 2022
dd7037e
fix links
ShaMan123 Oct 15, 2022
ba41cff
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
b410ebf
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
4a82839
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
b8304fb
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
d4c068e
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
0670cad
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
ddfc3b8
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
a70e659
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
6c4c0d6
Update CONTRIBUTING.md
ShaMan123 Oct 15, 2022
0c48509
Merge branch 'master' into readme
ShaMan123 Oct 15, 2022
4ffff6c
Update README.md
asturur Oct 15, 2022
7b349c1
Merge branch 'master' into readme
ShaMan123 Oct 15, 2022
a757257
Update README.md
ShaMan123 Oct 15, 2022
181cbc0
Merge branch 'readme' of https://github.com/fabricjs/fabric.js into r…
ShaMan123 Oct 15, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
ShaMan123 marked this conversation as resolved.
Show resolved Hide resolved
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)
- chore(): fix typos in intersection file [#8345](https://github.com/fabricjs/fabric.js/pull/8345)
- fix(textStyles): Handle empty style object in stylesToArray [#8357](https://github.com/fabricjs/fabric.js/pull/8357)
- ci(build): safeguard concurrent unlocking [#8309](https://github.com/fabricjs/fabric.js/pull/8309)
Expand Down
Loading