Skip to content

Commit

Permalink
Merge branch 'skeletonlabs:dev' into chore/tableOfContents-safeguard
Browse files Browse the repository at this point in the history
  • Loading branch information
ryceg committed May 29, 2023
2 parents de626f6 + 8557758 commit f9f543b
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "master",
"baseBranch": "dev",
"updateInternalDependencies": "patch",
"ignore": []
}
5 changes: 5 additions & 0 deletions .changeset/hip-dancers-march.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@skeletonlabs/skeleton": patch
---

Fix Toast jiggle when last toast remain
25 changes: 14 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: 🐞 Bug
description: File a bug/issue
title: "<title>"
description: Report an issue or bug
labels: [bug]
body:
- type: textarea
Expand All @@ -11,25 +10,29 @@ body:
required: false
- type: textarea
attributes:
label: Reproduction / Steps To Reproduce
description: Stackblitz/Link to a repository with steps to reproduce the behavior.
label: Expected Behavior
description: A description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Describe how to reproduce the issue.
placeholder: |
As you can see in this code example/Stackblitz link/repostitory
1. Using this component...
2. With these properties...
3. Click '...'
4. See error...
validations:
required: false
- type: markdown
- type: input
id: reproduction
attributes:
value: |
Bug Reports with a repository with a full reproduction or a Stackblitz can be anwswered far quicker, so please consider including as much information as possible to let us help you quicker!
label: Link to Reproduction / Stackblitz
- type: textarea
attributes:
label: Anything else?
label: More Information
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
Provide relevant links or additionl information.
validations:
required: false
15 changes: 2 additions & 13 deletions .github/ISSUE_TEMPLATE/docs_issue.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
name: 📗 Report Docs Issue
description: See a typo? Outdated or incorrect information? Let us know!
title: "<title>"
description: Use this to report a typo or incorrect information.
labels: [documentation]
body:
- type: markdown
attributes:
value: Sometimes something slips through the cracks, and the documentation is not quite right. Thanks for letting us know!
- type: input
id: link
attributes:
label: Link to the Page
- type: textarea
id: quote
attributes:
label: Describe the Issue
- type: dropdown
id: participate
attributes:
label: Are you able to create a Pull Request with the fix?
options:
- 'Yes'
- 'No'
label: Describe the Issue (screenshots encouraged!)
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: 🛠️ Request New Feature
description: Let us know what we should add.
description: Let us know what you would like to see added.
labels: ['feature request']
body:
- type: textarea
id: description
attributes:
label: Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!
label: Describe the feature in detail (code, mocks, or screenshots encouraged)
- type: dropdown
id: category
attributes:
Expand All @@ -19,4 +19,4 @@ body:
- type: textarea
id: references
attributes:
label: Any links to similar examples or other references we should review?
label: Provide relevant links or additional information.
30 changes: 19 additions & 11 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
## Before submitting the PR:
- [ ] Does your PR reference an issue? If not, please [chat to the team on Discord](https://discord.gg/EXqV7W8MtY) or [GitHub](https://github.com/skeletonlabs/skeleton/discussions) before submission.
- [ ] Did you update and run tests before submission using `npm run test`?
- [ ] Does your branch follow our [naming convention](https://www.skeleton.dev/docs/contributing)? If not, please amend the branch name using `branch -m new-branch-name`
- [ ] Did you update documentation related to your new feature or changes?
## Linked Issue

## What does your PR address?
Closes #{issueNumber}

Please briefly describe your changes here.
## Description

### Tips
- Tap "convert to draft" to indicate this is work in progress.
- Link to an issue using the verbiage [Fixes #XX](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
- Linked issues will auto-close when the PR is merged.
{description}

## Changsets

Changesets automate our changelog. If you modify files in `/package/skeleton`, run `pnpm changeset`, follow the prompts, then commit the markdown file. Changes that add features should be `minor` while chores and bugfixes should be `patch`. Please prefix the changeset message with `feat:`, `bugfix:` or `chore:`.

## Checklist

Please read and apply all [contribution requirements](https://www.skeleton.dev/docs/contributing/style-guide#feature-branches).

- [ ] This PR targets the `dev` branch (NEVER `master`)
- [ ] Documentation reflects all relevant changes
- [ ] Branch is prefixed with: `docs/`, `feat/`, `chore/`, `bugfix/`
- [ ] Ensure code linting is current - run `pnpm format`
- [ ] All test cases are passing - run `pnpm test`
- [ ] Includes a changeset (if relevant; see above)
2 changes: 1 addition & 1 deletion packages/skeleton/src/lib/utilities/Toast/Toast.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
// Base Classes
const cWrapper = 'flex fixed top-0 left-0 right-0 bottom-0 pointer-events-none';
const cSnackbar = 'flex flex-col space-y-2';
const cSnackbar = 'flex flex-col gap-y-2';
const cToast = 'flex justify-between items-center pointer-events-auto';
const cToastActions = 'flex items-center space-x-2';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
<li>Install <a class="anchor" href="https://pnpm.io/" target="_blank" rel="noreferrer">pnpm</a> globally using <code class="code">npm install -g pnpm</code>. Confirm via <code class="code">pnpm --version</code> in your terminal.</li>
<li>Run <code class="code">git clone https://github.com/skeletonlabs/skeleton.git</code> to clone the monorepo project.</li>
<li>Run <code class="code">cd skeleton</code> to move into the cloned monorepo project.</li>
<li>Delete your <code class="code">node_modules</code> directory, then run <code class="code">pnpm i</code> to install depedencies for all projects.</li>
<li>Delete your <code class="code">node_modules</code> directory, then run <code class="code">pnpm i</code> to install dependencies for all projects.</li>
<li>Run <code class="code">cd sites/skeleton.dev</code> to move into the Skeleton documentation project.</li>
<li>Run <code class="code">code .</code> to open the current project directory in VS Code.</li>
<li>Run <code class="code">pnpm dev</code> to start a local dev server. You may see a warning the first time.</li>
Expand All @@ -127,6 +127,60 @@
<CodeBlock language="typescript" code={`import { Avatar } from '@skeletonlabs/skeleton';`} />
</section>

<!-- Changesets -->
<section class="space-y-4">
<h2 class="h2">Changesets</h2>
<p>
<!-- prettier-ignore -->
Once you have a PR that is ready, it'll be time to add a
<a class="anchor" href="https://github.com/changesets/changesets" target="_blank" rel="noreferrer">Changeset</a>. We use changesets to help
automate our versioning, changelogs, and releases.
</p>
<p>
We will be creating changesets using the Changeset CLI. The CLI will walk us through the process by having us select the packages and
their respective version bumps. Version bumps are how we increment the versions for our packages and they come in 3 flavors:
<code class="code">major</code>,
<code class="code">minor</code>, and <code class="code">patch</code>.
</p>
<p>
Generally, new features are <code class="code">minor</code> bumps while bugfixes and chores are <code class="code">patch</code> bumps.
When writing the summary for the changeset, be sure to <u>prefix</u> the message with either
<code class="code">feat:</code>,
<code class="code">bugfix:</code>, or <code class="code">chore:</code>.
</p>
<Table
source={{
head: ['Prefix', 'When to use', 'Version Bump'],
body: [
['<code class="code">feat:</code>', 'For when a new feature is added', '<code class="code">minor</code>'],
['<code class="code">bugfix:</code>', 'For bug fixes', '<code class="code">patch</code>'],
['<code class="code">chore:</code>', 'For dependency and general project management', '<code class="code">patch</code>']
]
}}
/>
<!-- prettier-ignore -->
<h3 class="h3">Adding a Changeset</h3>
<ol class="list-decimal list-inside space-y-2">
<li>Navigate to the root directory of the monorepo.</li>
<li>Run <code class="code">pnpm changeset</code> to run the Changeset CLI.</li>
<li>
Press <kbd class="kbd">Space</kbd> to select the package(s) you would like to add a changeset for. Once selected, press
<kbd class="kbd">Enter</kbd>.
</li>
<li>
Now it's time to select a version bump. If it's the version bump you desire, press
<kbd class="kbd">Space</kbd>
to select the package(s) that it will apply to, and press <kbd class="kbd">Enter</kbd>
to submit. Otherwise, press <kbd class="kbd">Enter</kbd> to move on to the next version bump option.
</li>
<li>
You will now be prompted to write a summary. <u>Prefix</u> your summary with either <code class="code">feat:</code>,
<code class="code">bugfix:</code>, or <code class="code">chore:</code>. Then briefly describe the change you implemented.
</li>
<li>Confirm the changes and commit the newly generated markdown file.</li>
</ol>
</section>

<!-- Tooling -->
<section class="space-y-4">
<h2 class="h2">Tooling</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
<!-- Toast Store -->
<section class="space-y-4">
<h2 class="h2">Toast Store</h2>
<p>The Modal Store acts as a queue for your toast messages.</p>
<p>The Toast Store acts as a queue for your toast messages.</p>
<CodeBlock
language="ts"
code={`import { toastStore } from '@skeletonlabs/skeleton';
Expand Down

0 comments on commit f9f543b

Please sign in to comment.