Skip to content

Commit

Permalink
chore(repo): update all package readmes (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
shellscape committed Sep 26, 2023
1 parent af6a9a5 commit a45a3b2
Show file tree
Hide file tree
Showing 85 changed files with 1,822 additions and 1,532 deletions.
20 changes: 0 additions & 20 deletions .github/DISCUSSION_TEMPLATE/help.yml

This file was deleted.

23 changes: 0 additions & 23 deletions .github/DISCUSSION_TEMPLATE/ideas.yml

This file was deleted.

69 changes: 0 additions & 69 deletions .github/ISSUE_TEMPLATE/1.bug_report.yml

This file was deleted.

53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: 🐞 Bug Report
about: Something went awry and you'd like to tell us about it.

---

<!--
⚡️ katchow! We 💛 issues.
🚨 Your issue will be CLOSED if:
- This template is removed
- Parts of this template are removed
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions
❤️ JSX email? Please consider sponsoring our maintainers or telling others about us!
-->

- Component or Package Name:
- Component or Package Version:
- `@jsxp-email/cli` Version?:
- Operating System (or Browser):
- Node Version:
- Link to reproduction _(⚠️ read below)_:

<!--
🚨 Issues WITHOUT a valid reproduction WILL BE CLOSED!
Please provide one by:
1. Using the StackBlitz reproduction template at https://stackblitz.com/fork/jsx-email-repro
2. Provide a minimal repository link (Read https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d70ff for instructions).
Please use NPM for installing dependencies!
These may take more time to triage than the other options.
⚠️ ZIP Files are unsafe and maintainers will NOT download them.
-->


### Expected Behavior


### Actual Behavior


### Additional Information

<!--
Most issues can be expressed or demonstrated through StackBlitz or a repository.
However, the situation may arise where some small code snippets also need to
be provided. In that situation, please add your code below using
Fenced Code Blocks (https://help.github.com/articles/creating-and-highlighting-code-blocks/)
-->
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: 📚 Documentation
about: Are the docs lacking or missing something? Do they need some new 🔥 hotness? Tell us here.

---

<!--
⚡️ katchow! We 💛 issues.
Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions
❤️ JSX email? Please consider sponsoring our maintainers or telling others about us!
-->

- Component or Package Name:
- Component or Package Version:

Documentation Is:

<!-- Please place an x (no spaces!) in all [ ] that apply -->

- [ ] Missing
- [ ] Needed
- [ ] Confusing
- [ ] Not Sure?

### Please Explain in Detail...


### Your Proposal for Changes
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: ✨ Feature Request
about: Suggest an idea for this project

---

<!--
⚡️ katchow! We 💛 issues.
Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions
❤️ JSX email? Please consider sponsoring our maintainers or telling others about us!
-->

- Component or Package Name:
- Component or Package Version:

### Feature Use Case


### Feature Proposal
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/MODIFICATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: 🔧 Modification Request
about: Would you like something work differently? Have an alternative approach? This is the template for you.

---

<!--
⚡️ katchow! We 💛 issues.
Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions
❤️ JSX email? Please consider sponsoring our maintainers or telling others about us!
-->

- Component or Package Name:
- Component or Package Version:

### Expected Behavior / Situation


### Actual Behavior / Situation


### Modification Proposal
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/NEW_COMPONENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: 🔌 New Component
about: Request a new Component or Tools

---

<!--
⚡️ katchow! We 💛 issues.
Please - do not - remove this template.
Please - do not - skip or remove parts of this template.
Or your issue may be closed.
👉🏽 Need help or tech support? Please don't open an issue!
Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions
❤️ JSX email? Please consider sponsoring our maintainers or telling others about us!
-->

Request Checklist:

<!--
Required Steps Before Opening This Issue
Please [x] check the boxes to acknowledge you have performed these tasks
-->
- [ ] I have searched https://npmjs.com/ before opening this issue
- [ ] I have searched https://jsx.email/docs before opening this issue

### New Component/Tool Use Case

<!--
Please describe the need for the new plugin, how it makes
sense for your scenario, or other information that describes
the community need for this plugin.
Screenshots are great if you have them.
Code is great to see if you can provide snippets.
-->

### New Component/Tool Proposal

<!--
Use this area to describe how the new plugin might behave,
options that it might have, or other resources that might
be useful to the plugin you're proposing.
-->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: 🆘 Support, Help, and Advice
about: 👉🏽 Need help or tech support? Please don't open an issue! Head to https://discord.gg/E9ZGqYRZ or start a Discussion https://github.com/shellscape/jsx-email/discussions

---

Hey there! If you need help or tech support then this is not the place to
ask. Please head to our [Discord](https://discord.gg/E9ZGqYRZ)
instead or start a Discussion https://github.com/shellscape/jsx-email/discussions.

If you arrived here because you think JSX email's documentation is unclear,
insufficient or wrong, please consider creating an issue for the documentation
instead.
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

59 changes: 51 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,54 @@
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
<!--
⚡️ katchow! We ❤️ Pull Requests!
The PR name should follow `<type>(<scope>): <Message>`
If you remove or skip this template, you'll make the 🐼 sad and the mighty god
of Github will appear and pile-drive the close button from a great height
while making animal noises.
Examples:
- New feature: `feat(button): Add new thing`
- Fix: `fix(react-email): Dev command
- Misc/Chore: `chore(root): Update `readme.md`
Pull Request Requirements:
* Please include tests to illustrate the problem this PR resolves.
* Please lint your changes by running `moon run repo:lint` before creating a PR.
* Please update the documentation in `/docs` where necessary
-->

## Component / Package Name:

This PR contains:
<!-- Please place an 'x' like this [x] in all boxes that apply. -->
- [ ] bugfix
- [ ] feature
- [ ] refactor
- [ ] documentation
- [ ] other

Are tests included?

- [ ] yes (_bugfixes and features will not be merged without tests_)
- [ ] no

Breaking Changes?

- [ ] yes (_breaking changes will not be merged unless absolutely necessary_)
- [ ] no

If yes, please include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.

List any relevant issue numbers:

<!--
If this PR resolves any issues, list them as
resolves #1234
Where 1234 is the issue number. This will help us with house-keeping as Github will automatically add a note to those issues stating that a potential fix exists. Once the PR is merged, Github will automatically close those issues.
If an issue is only solved partially or is relevant in some other way, just list the number without "resolves".
-->

### Description

<!--
Please be thorough and clearly explain the problem being solved.
* If this PR adds a feature, look for previous discussion on the feature by searching the issues first.
* Is this PR related to an issue?
-->
Loading

0 comments on commit a45a3b2

Please sign in to comment.