Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos #92

Merged
merged 5 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ body:
attributes:
label: More Information
description: |
Provide relevant links or additionl information.
Provide relevant links or additional information.
validations:
required: false
14 changes: 7 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ Closes #{issueNumber}

{description}

## Changsets
## Changesets

We use [Changesets](https://github.com/changesets/changesets) to automatically create our changelog per each release. Any changes or additions to the Library assets in `/lib` must be documented with a new Changeset. This can be done as follows:

2. Navigate to the root of the project on your feature branch.
3. Run `pnpm changeset` to trigger the Changeset CLI.
4. Follow the instructions when prompted.
1. Navigate to the root of the project on your feature branch.
2. Run `pnpm changeset` to trigger the Changeset CLI.
3. Follow the instructions when prompted.
- Changesets should be either `minor` or `patch`. Never `major`.
- Prefix your Changeset description using: `feature:`, `chore:` or `bugfix:`.
5. Changeset `.md` files are added to the `/.changeset` directory.
6. Commit and push the the new changeset file.
4. Changeset `.md` files are added to the `/.changeset` directory.
5. Commit and push the the new changeset file.

## Checklist

Expand All @@ -25,6 +25,6 @@ Please read and apply all [contribution requirements](https://github.com/skeleto
- [ ] PR targets the `dev` branch (NEVER `master`)
- [ ] All website documentation is current with your changes
- [ ] Ensure Prettier formatting is current - run `pnpm format`
- [ ] Ensure Prettier linting is current - run `pnpm format`
- [ ] Ensure ESLint linting is current - run `pnpm lint`
- [ ] All test cases are passing - run `pnpm test`
- [ ] Includes a changeset (if relevant; see above)
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Take care to read all contributions guidelines before you begin!

## Using PNPM

Floating UI Sveltes makes use of [PNPM](https://pnpm.io/).
Floating UI Svelte makes use of [PNPM](https://pnpm.io/).

1. [Install PNPM](https://pnpm.io/installation) on your local computer.
2. [Fork the repository](https://github.com/skeletonlabs/floating-ui-svelte) via your preferred option.
3. Use Git to clone the forked project to your local machine.
4. Point your terminal at the project.
5. Run `pnpm i` to install the required depedencies.
5. Run `pnpm i` to install the required dependencies.
6. Run `pnpm dev` to start a local dev server.

## Project Structure
Expand All @@ -41,7 +41,7 @@ Floating UI Svelte uses two primary branches. All pull requests should be create

| Branch | Description | Pull Requests |
| --- | --- | --- |
| `dev` | The developement branch. | Allowed |
| `dev` | The development branch. | Allowed |
| `main` | The release branch. | Never |

### PR Branch Conventions
Expand All @@ -55,7 +55,7 @@ Please use the following naming convention when creating your pull request.
| `chore/*` | When implementing small changes. |
| `bugfix/*` | When implementing feature bugfixes. |

Keep branch names short and semantic, using dashes to seperate words.
Keep branch names short and semantic, using dashes to separate words.

```
docs/getting-started-typo-fix
Expand Down
2 changes: 1 addition & 1 deletion src/app.pcss
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ body {
@apply bg-surface-200 dark:bg-surface-800;
}

/* Typogrpahy --- */
/* Typography --- */

/* Headings */
.h1 {
Expand Down
2 changes: 1 addition & 1 deletion src/docs/stores.svelte.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Resuable State Stores
// Reusable State Stores

// Navigation Drawer ---

Expand Down
2 changes: 1 addition & 1 deletion src/docs/themes/moonlight-dark.json
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@
}
},
{
"name": "CSS psuedo selectors",
"name": "CSS pseudo selectors",
"scope": [
"entity.other.attribute-name.pseudo-class",
"entity.other.attribute-name.pseudo-element"
Expand Down
2 changes: 1 addition & 1 deletion src/lib/components/FloatingArrow/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { FloatingContext } from '$lib/hooks/useFloating/index.svelte.js';
import type { SVGAttributes } from 'svelte/elements';

export interface FloatingArrowProps extends SVGAttributes<SVGElement> {
/** The binded HTML element reference. */
/** The bound HTML element reference. */
ref: Element | null;
/** The floating context. */
context: FloatingContext;
Expand Down
4 changes: 2 additions & 2 deletions src/lib/hooks/useHover/index.test.svelte.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import App from './App.test.svelte';
vi.useFakeTimers();

describe('useHover', () => {
it('opens on mousenter', async () => {
it('opens on mouseEnter', async () => {
render(App);

await fireEvent.mouseEnter(screen.getByTestId('reference'));
Expand Down Expand Up @@ -76,7 +76,7 @@ describe('useHover', () => {
});

describe('restMs', () => {
it('opens on mousenter once restMs has passed', async () => {
it('opens on mouseEnter once restMs has passed', async () => {
render(App, { restMs: 100 });

await fireEvent.mouseMove(screen.getByTestId('reference'));
Expand Down
2 changes: 1 addition & 1 deletion src/lib/hooks/useInteractions/index.test.svelte.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ describe('useInteractions', () => {
expect(count).toBe(1);
}),
);
it('overrides duplicate non-eventlistener props with the prop from the last ineraction passed in that has said duplicate prop', () => {
it('overrides duplicate non-eventlistener props with the prop from the last interaction passed in that has said duplicate prop', () => {
const interactionOne: ElementProps = {
reference: {
id: 'one',
Expand Down
2 changes: 1 addition & 1 deletion src/lib/hooks/useRole/index.test.svelte.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ describe('useRole', () => {

await rerender({ role: 'tooltip', open: false });

expect(screen.getByRole('buton')).not.toHaveAttribute('aria-labelledby');
expect(screen.getByRole('button')).not.toHaveAttribute('aria-labelledby');
});
});

Expand Down
2 changes: 1 addition & 1 deletion src/routes/+error.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// FIXME: https://github.com/sveltejs/eslint-plugin-svelte/issues/652
// eslint-disable-next-line svelte/valid-compile
const status = $derived($page.status);
// elint-disable-next-line svelte/valid-compile
// eslint-disable-next-line svelte/valid-compile
const message = $derived($page.error ? $page.error.message : 'Unknown error');
</script>

Expand Down