Skip to content

Commit

Permalink
chore(github): add issue form templates
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieMason committed Oct 20, 2024
1 parent 32847a2 commit 35dea02
Show file tree
Hide file tree
Showing 6 changed files with 190 additions and 53 deletions.
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: 🐞 Bug report
description: Explain how to reproduce a Bug
title: "fix: "
labels: ["Type: Fix"]
body:
- type: input
validations:
required: true
attributes:
label: Syncpack version
placeholder: eg. 13.0.0
- type: dropdown
validations:
required: true
attributes:
label: Operating system(s)
multiple: true
options:
- Linux
- Mac
- Windows
- type: textarea
validations:
required: true
attributes:
label: Steps to reproduce
description: |
A shell script would be perfect, otherwise a bullet list of precise steps to follow (less is more).
<details>
<summary>Example</summary>
```bash
git clone https://github.com/YOUR_ORG/syncpack-reproduction.git
cd syncpack-reproduction
npm exec syncpack -- lint
```
</details>
- type: textarea
validations:
required: true
attributes:
label: Expected behavior
description: A concise description of what you expected to happen.
- type: textarea
validations:
required: true
attributes:
label: Actual behavior
description: A concise description of what happened instead.
- type: textarea
validations:
required: false
attributes:
label: Contents of syncpack configuration file
description: |
If you have not provided a reproduction, at minimum I'd need to see your config to be able to help you.
> [!IMPORTANT]
> There's nothing better than a public repo which reproduces the problem, as the combination of your config and the contents and locations of your package.json files are what form the complete picture.
render: jsonc
- type: textarea
validations:
required: false
attributes:
label: Optional comments
description: Any further thoughts, ideas, comments, or context.
- type: markdown
attributes:
value: |
### Community health
A healthy community is built on fairness, mutual respect, support and collaboration. By giving back — whether through code contributions, documentation, testing, or simply spreading the word — you help maintain a vibrant and sustainable project.
| Contribution | Cost |
| :----------------------------------------------------------------------------------------- | :--------- |
| [Sponsor](https://github.com/sponsors/JamieMason?frequency=one-time) | 🔴 Money |
| [Contribute Rust code](https://github.com/JamieMason/syncpack/tree/rust/main) | 🟠 Time |
| [Improve the docs](https://github.com/JamieMason/syncpack/tree/main/site/src/content/docs) | 🟡 Time |
| [Star syncpack](https://github.com/JamieMason/syncpack) | 🟢 Nothing |
| **Recommend syncpack** to others | 🟢 Nothing |
- type: checkboxes
attributes:
label: Code of Conduct
options:
- label: I agree to follow the [Code of Conduct](https://github.com/JamieMason/syncpack/blob/main/CODE_OF_CONDUCT.md)
required: true
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 🎁 Feature request
description: Suggest an idea for this project
title: "feat: "
labels: ["Type: Feat"]
body:
- type: textarea
validations:
required: true
attributes:
label: Description
description: |
Try to capture:
- Why the feature is required
- What problem(s) it solves
- Real world scenarios or use cases
- What alternatives exist that you might have considered
- Why syncpack is the right place for this to live
- type: textarea
validations:
required: true
attributes:
label: Suggested Solution
description: |
Provide code examples of what using this feature would look like from an end user's point of view.
- What would running the `syncpack` CLI command look like?
- What would the CLI output contain?
- What would changes or additions to the config file look like?
- type: textarea
validations:
required: false
attributes:
label: Optional comments
description: Any further thoughts, ideas, comments, or context.
- type: markdown
attributes:
value: |
### Community health
A healthy community is built on fairness, mutual respect, support and collaboration. By giving back — whether through code contributions, documentation, testing, or simply spreading the word — you help maintain a vibrant and sustainable project.
| Contribution | Cost |
| :----------------------------------------------------------------------------------------- | :--------- |
| [Sponsor](https://github.com/sponsors/JamieMason?frequency=one-time) | 🔴 Money |
| [Contribute Rust code](https://github.com/JamieMason/syncpack/tree/rust/main) | 🟠 Time |
| [Improve the docs](https://github.com/JamieMason/syncpack/tree/main/site/src/content/docs) | 🟡 Time |
| [Star syncpack](https://github.com/JamieMason/syncpack) | 🟢 Nothing |
| **Recommend syncpack** to others | 🟢 Nothing |
- type: checkboxes
attributes:
label: Code of Conduct
options:
- label: I agree to follow the [Code of Conduct](https://github.com/JamieMason/syncpack/blob/main/CODE_OF_CONDUCT.md)
required: true
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: ❓ Question
description: Get help with something
title: "question: "
labels: ["Type: Question"]
body:
- type: markdown
attributes:
value: |
### Useful links
You're welcome to ask questions, but have a look at these resources as it's possible your question has already been answered:
- [Most upvoted questions](https://github.com/JamieMason/syncpack/issues?q=label%3A%22Type%3A+Question%22+sort%3Areactions-%2B1-desc)
- [Getting started](https://jamiemason.github.io/syncpack/guide/getting-started/)
- [Examples](https://jamiemason.github.io/syncpack/examples/)
- [Documentation](https://jamiemason.github.io/syncpack/config/syncpackrc/)
- type: textarea
validations:
required: true
attributes:
label: Question
description: Ask your question
- type: markdown
attributes:
value: |
### Community health
A healthy community is built on fairness, mutual respect, support and collaboration. By giving back — whether through code contributions, documentation, testing, or simply spreading the word — you help maintain a vibrant and sustainable project.
| Contribution | Cost |
| :----------------------------------------------------------------------------------------- | :--------- |
| [Sponsor](https://github.com/sponsors/JamieMason?frequency=one-time) | 🔴 Money |
| [Contribute Rust code](https://github.com/JamieMason/syncpack/tree/rust/main) | 🟠 Time |
| [Improve the docs](https://github.com/JamieMason/syncpack/tree/main/site/src/content/docs) | 🟡 Time |
| [Star syncpack](https://github.com/JamieMason/syncpack) | 🟢 Nothing |
| **Recommend syncpack** to others | 🟢 Nothing |
- type: checkboxes
attributes:
label: Code of Conduct
options:
- label: I agree to follow the [Code of Conduct](https://github.com/JamieMason/syncpack/blob/main/CODE_OF_CONDUCT.md)
required: true
16 changes: 16 additions & 0 deletions site/src/content/docs/examples/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Monorepo configuration examples
sidebar:
hidden: true
---

- [Ban dependency from monorepo](/syncpack/examples/ban-dependency-from-monorepo/)
- [Ensure AWS SDK dependencies always have the same version](/syncpack/examples/fix-aws-sdk-version-mismatch/)
- [Ensure that semver ranges for a dependency all match each other](/syncpack/examples/ensure-versions-satisfy-same-range/)
- [Fix React Native version mismatch](/syncpack/examples/fix-react-native-version-mismatch/)
- [Hide dependencies from syncpack](/syncpack/examples/ignore-dependencies-in-syncpack/)
- [Manage monorepo packageManager version](/syncpack/examples/sync-package-manager-version/)
- [Manage npm engines throughout monorepo](/syncpack/examples/sync-engines-in-monorepo/)
- [Only allow @types packages in devDependencies](/syncpack/examples/only-allow-types-in-dev-dependencies/)
- [Pin local versions to pnpm workspace:\*](/syncpack/examples/pnpm-workspace-protocol/)
- [Synchronise Node.js version in monorepo](/syncpack/examples/sync-nodejs-version-in-monorepo/)

0 comments on commit 35dea02

Please sign in to comment.