Skip to content
15 changes: 15 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Skeleton-only files: plugin-elementary's own repository settings, which must
# not reach a plugin created from the skeleton. `composer create-project`
# installs the Packagist dist archive, and export-ignore leaves these out of
# it. For a git clone, `npm run init` removes the same files (cleanup.targets
# in bin/scaffold.config.js); keep the two lists in step.
/.gitattributes export-ignore
/.github/CODEOWNERS export-ignore
/.github/ISSUE_TEMPLATE/bug.yml export-ignore
/.github/ISSUE_TEMPLATE/config.yml export-ignore
/.github/ISSUE_TEMPLATE/feature.yml export-ignore
/.github/labels.yml export-ignore
/SECURITY.md export-ignore
/.github/release-starter export-ignore
Comment thread
aryanjasala marked this conversation as resolved.
Resolved
/.github/workflows/release-starter.yml export-ignore
/tests/js/starter-files.test.js export-ignore
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

136 changes: 107 additions & 29 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,128 @@
name: Bug Report Form
description: If something isn't working as expected
name: Bug report
description: Something in the plugin-elementary skeleton is broken or behaves unexpectedly.
type: Bug
Comment thread
aryanjasala marked this conversation as resolved.
Resolved
labels:
- bug
- "Type: Bug"
body:
- type: textarea
- type: markdown
attributes:
value: >-
Thanks for reporting a bug. Please search
[existing issues](https://github.com/rtCamp/plugin-elementary/issues?q=is%3Aissue)
first. Bugs in the framework belong in
[wp-primitives](https://github.com/rtCamp/wp-primitives/issues), and
bugs in `npm run init` or `npx wp-tooling` in
[wp-tooling](https://github.com/rtCamp/wp-tooling/issues).
- type: markdown
attributes:
value: >-
**Found a security issue?** Do not open a public issue. Report it
privately through
[GitHub's vulnerability reporting](https://github.com/rtCamp/plugin-elementary/security/advisories/new),
as [SECURITY.md](https://github.com/rtCamp/plugin-elementary/blob/main/SECURITY.md)
describes.
- type: input
id: starter-version
attributes:
label: Current Behaviour
description: A clear and concise description of the buggy behavior.
label: Skeleton version or commit
description: >-
The release you started from (`composer create-project` prints it) or,
if you cloned `main`, the commit SHA.
placeholder: 1.0.0, or a1b2c3d
validations:
required: true
- type: textarea
- type: dropdown
id: where
attributes:
label: Expected Behaviour
description: >-
A clear and concise description of what you expected to happen (or
code).
label: Where does it happen?
options:
- In the skeleton itself, before `npm run init`
- In a plugin created from the skeleton, after `npm run init`
- During `composer create-project` or `npm run init`
validations:
required: true
- type: dropdown
id: area
attributes:
label: Area
options:
- "Init and capabilities (npm run init, bin/scaffold.config.js)"
- "Modules and examples (inc/Modules/)"
- "Core services (inc/Core/)"
- "Blocks and assets (src/, webpack, HMR, Tailwind)"
- "Tests and lint (PHPUnit, Jest, PHPCS, PHPStan, ESLint, Stylelint)"
- "CI workflows"
- Documentation
- Not sure
validations:
required: false
- type: input
id: wp-version
attributes:
label: WordPress version
placeholder: "6.8"
validations:
required: true
- type: input
id: php-version
attributes:
label: PHP version
placeholder: "8.3"
validations:
required: true
- type: input
id: node-version
attributes:
label: Node version
description: The output of `node --version`. The skeleton expects the version in `.nvmrc`.
placeholder: v22.22.2
validations:
required: true
- type: input
id: environment
attributes:
label: Local environment
description: Where WordPress runs, if relevant, and whether it is multisite.
placeholder: wp-env, VIP dev-env, Local, a remote host
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: Steps to reproduce the bug
description: Steps to reproduce if any.
placeholder: Steps to reproduce bug.
value: |-
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
label: What happened?
description: The error or behaviour you saw. Screenshots help for editor and admin bugs.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Testing Environment (if applicable)
description: Steps to reproduce if any.
label: What did you expect to happen?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Additional context/Screenshots
description: >-
Add any other context about the problem here. If applicable, add
screenshots to help explain.
label: Steps to reproduce
placeholder: |
1. composer create-project rtcamp/plugin-elementary demo-features
2. cd demo-features && npm install && npm run init
3. ...
validations:
required: true
- type: input
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Terminal output, PHP errors or browser console errors. Rendered as code, so no backticks are needed.
render: shell
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Estimated time in hours
description: Enter the estimated time required to finish this task.
placeholder: 40 Hours
label: Before you submit
options:
- label: I searched the existing issues and this is not a duplicate.
required: true
- label: I removed secrets, keys and private URLs from everything above.
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Report a security vulnerability
url: https://github.com/rtCamp/plugin-elementary/security/advisories/new
about: Report security issues privately, never in a public issue. See SECURITY.md.
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/enhancement.yml

This file was deleted.

77 changes: 65 additions & 12 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,78 @@
name: Feature Request
description: template for missing feature
title: '[Feature Request]: '
name: Feature request
description: Suggest a new capability, or an improvement to an existing one, for the skeleton.
type: Feature
Comment thread
aryanjasala marked this conversation as resolved.
Resolved
labels:
- feature
- "Type: Feature"
body:
- type: markdown
attributes:
value: >-
Thanks for the suggestion. Please search
[existing issues](https://github.com/rtCamp/plugin-elementary/issues?q=is%3Aissue)
first.
- type: markdown
attributes:
value: >-
Every plugin created from this skeleton copies it, so additions should
be general enough for most projects. Framework behaviour belongs in
[wp-primitives](https://github.com/rtCamp/wp-primitives), the init and
scaffold engine in [wp-tooling](https://github.com/rtCamp/wp-tooling),
and CI jobs in
[wp-shared-workflows](https://github.com/rtCamp/wp-shared-workflows).
[CONTRIBUTING.md](https://github.com/rtCamp/plugin-elementary/blob/main/CONTRIBUTING.md)
explains how to build it yourself.
- type: dropdown
id: kind
attributes:
label: Kind of request
options:
- Something new the skeleton does not do yet
- An improvement to something it already does
validations:
required: true
- type: dropdown
id: area
attributes:
label: Area
options:
- "Init and capabilities (npm run init, bin/scaffold.config.js)"
- "Modules and examples (inc/Modules/)"
- "Core services (inc/Core/)"
- "Blocks and assets (src/, webpack, HMR, Tailwind)"
- "Tests and lint (PHPUnit, Jest, PHPCS, PHPStan, ESLint, Stylelint)"
- "CI workflows"
- "AI tooling (AGENTS.md, Claude skills, Copilot prompts)"
- Documentation
- Not sure
validations:
required: true
- type: textarea
id: problem
attributes:
label: Description
description: A clear and concise description of the problem or missing capability
label: What problem does this solve?
description: A clear description of the problem or missing capability.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Describe the solution you'd like
description: If you have a solution in mind, please describe it.
description: >-
What the skeleton should ship, and whether it should be always on, a
capability that init can remove, or an optional feature.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Have you considered any alternative solutions or workarounds?
- type: input
description: Workarounds you use now, or other designs you ruled out.
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Estimated time in hours
description: Enter the estimated time required to finish this task.
placeholder: 40 Hours
label: Before you submit
options:
- label: I searched the existing issues and this is not a duplicate.
required: true
Loading
Loading