Skip to content

Commit

Permalink
ci(): guides follow up (fabricjs#8379)
Browse files Browse the repository at this point in the history
Fix left overs from fabricjs#8189 

- typos
- links
- add feature request template
- update bug report action to run on master always

Co-authored-by: Steve Eberhardt <melchiar2@gmail.com>
  • Loading branch information
2 people authored and frankrousseau committed Jan 6, 2023
1 parent 135207d commit 016e924
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 20 deletions.
13 changes: 5 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,24 @@ body:
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).
For anything else (such as questions) 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)
Conduct](https://github.com/fabricjs/fabric.js/blob/master/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)
Guide](https://github.com/fabricjs/fabric.js/blob/master/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)
Guide](https://github.com/fabricjs/fabric.js/blob/master/CONTRIBUTING.md#%EF%B8%8F-issue-tracker)
required: true
- label: I have searched and referenced existing issues and discussions
required: true
Expand Down Expand Up @@ -72,7 +69,7 @@ body:
label: In What environments are you experiencing the problem?
description: >-
checkout the [supported
browsers](/README.md#supported-browsersenvironments)
browsers](https://github.com/fabricjs/fabric.js/blob/master/README.md#supported-browsersenvironments)
multiple: true
options:
- Firefox
Expand Down
8 changes: 7 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@

blank_issues_enabled: false
contact_links:
- name: Website
url: http://fabricjs.com/
about: Checkout the website.
- name: Docs
url: http://fabricjs.com/docs/
about: Checkout the docs.
- name: Discussions
url: ./discussions
url: https://github.com/fabricjs/fabric.js/discussions
about: Please ask and answer questions here.
- name: GOTCHAS
url: http://fabricjs.com/fabric-gotchas
Expand Down
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🔓 Feature Request
description: File a feature request
title: '[Feature]: '
body:
- type: markdown
attributes:
value: >
Thank you for wanting to contribute to this repository.
Before you do, please ensure you are filing the ticket in the right
place.
If you have a question use
[Discussions](https://github.com/fabricjs/fabric.js/discussions).
If you are interested in submitted a PR see [Pull Requests](https://github.com/fabricjs/fabric.js/blob/master/CONTRIBUTING.md#-pull-requests).
We recommend submitting a feature request and waiting for approval **before** you begin coding new features.
- type: checkboxes
id: terms
attributes:
label: CheckList
description: >-
By submitting this ticket, you agree to follow our [Code of
Conduct](https://github.com/fabricjs/fabric.js/blob/master/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/blob/master/CONTRIBUTING.md)
required: true
- label: I have searched and referenced existing issues, feature requests and discussions
required: true
- label: I am filing a **FEATURE** request.
required: true
- type: textarea
id: description
attributes:
label: Description
description: |
Detail your suggestion and the desired behavior.
Provide screenshots/screencasts if relevant.
validations:
required: true
- type: textarea
id: current
attributes:
label: Current State
description: Detail current state/behavior and existing solutions/workarounds
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Provide additional context
validations:
required: false
11 changes: 3 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
---
name: Pull Request
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.
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.
Adding tests that verify your fix and safeguard it from unwanted loss and changes is a MUST.
PRing is not always simple, don't hestitate to ask for help (beware of 'em gotchas 😓).
Pull Requests are not always simple. Don't hesitate to ask for help (beware of [gotchas](http://fabricjs.com/fabric-gotchas) 😓).
We appreciate your effort and would like the process to be productive and enjoyable.
A strong community means a strong and better product for everyone.
-->

<!--
📣 IMPORTANT NOTICE - PR LOCKDOWN 🔒 04/2022
📣 IMPORTANT NOTICE - PR LOCK DOWN 🔒 04/2022
We are excited to announce that fabric is migrating to modern typescript/javascript 🤩.
This means we will ⛔ not be accepting any PRs out of scope with the migration.
We understand this might be annoying but wasted work is ever more so.
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/npmpublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ jobs:
runs-on: ubuntu-latest
# wait for publishing to complete
needs: publish-npm
if: always()
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.release.target_commitish }}
ref: master
- name: Update bug report version
uses: ShaMan123/gha-populate-form-version@v2.0.1
with:
Expand All @@ -47,7 +48,7 @@ jobs:
with:
add-paths: .github/ISSUE_TEMPLATE/bug_report.yml
branch: ci-update-bug-report
base: ${{ needs.pre.outputs.branch }}
base: master
delete-branch: true
labels: CI/CD, bot, task
title: 'chore(): Update bug report'
Expand Down
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(): guides follow up, feature request template [#8379](https://github.com/fabricjs/fabric.js/pull/8379)
- 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`
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Fabric is an open source project 🦄 and as such depends on the **genuine effor
### ✅ Guidelines

- **Code Style** \
Fabric uses [`prettier`][prettier] to format files and [`eslint`][eslint]) for linting (`npm run lint -- --fix`).\
Fabric uses [`prettier`][prettier] to format files and [`eslint`][eslint] for linting (`npm run lint -- --fix`).\
To enjoy a seamless dev experience add the [`Prettier - Code formatter`][prettier_extension] extension via the extensions toolbar in VSCode.
- **`dist`** \
Commit changes to [source files](src). Don't commit the generated [distribution files](dist).
Expand Down

0 comments on commit 016e924

Please sign in to comment.