Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 10 additions & 0 deletions .changeset/bright-tires-find.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"@smart-wizard/core": patch
"@smart-wizard/extension-swipe": patch
"@smart-wizard/extension-url-hash": patch
"@smart-wizard/react": patch
"@smart-wizard/ui": patch
"@smart-wizard/vue": patch
---

Initial corrections and readme updates
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at hello.techlab@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing

## How can I contribute?
- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/smart-wizard/issues/).
- Add new features to the project.
- Create new themes
- Add new test cases.
- Add documentation.
- Add a demo page.
- [GitHub Sponsor](https://github.com/sponsors/techlab) - Sponsor on GitHub.

## How to contribute code?
Here are the basic steps to get started contributing code:

1. Fork the [repo](https://github.com/techlab/smart-wizard/).
2. Install the dependencies, run `pnpm install`.
3. Start the project, run `pnpm start`.
4. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
5. Modify the code to fix the bug or to add the feature. All changes should happen in the relevant source files.
6. Verify that your fix or feature works.
7. Run the test cases by running `pnpm test`, you can also add more test cases based on your new change.
8. Build the code by running `pnpm run build`.
9. Commit your changes with an informative description.
10. Open a pull request to the [develop](https://github.com/techlab/smart-wizard/tree/dev) branch of the [repo](https://github.com/techlab/smart-wizard/) with your new commit and a descriptive message about what the PR does.

Thank you for your contribution!

##### Notes for pull request
- Follow the same code style as the library.
- Run the test suites in the `test` directory first by running `pnpm test`.
- Don't alter the licence headers.

## Reporting bugs
#### Make sure it is a bug related to this project
Before reporting the bug, please make sure that the bug is in the project and not from your own code or any other library used.

#### Try the latest version
Bugs in the older versions of the project may have already been fixed.
In order to avoid reporting known issues, make sure you are always testing against the latest release.
Also make sure the problem hasn't already been reported on the [GitHub Issues Tracker](https://github.com/techlab/smart-wizard/issues/).
If not, create a new issue there and include your test case.

## Contributors
Million thanks to all our [Code Contributors](https://github.com/techlab/smart-wizard/graphs/contributors) and Supporters.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**A modern, framework-agnostic wizard / multi-step component.**
Zero dependencies · TypeScript · React & Vue adapters · Accessible · Themeable

_**SmartWizard** is the next-generation continuation of the popular [jQuery SmartWizard](https://techlaboratory.net/smartwizard), rebuilt from the ground up for the modern web._
> **SmartWizard** is the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard), rebuilt from the ground up for the modern web.

---

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"component"
],
"license": "MIT",
"homepage": "https://techlaboratory.net/smart-wizard",
"repository": {
"type": "git",
"url": "https://github.com/techlab/smart-wizard.git"
Expand Down
2 changes: 1 addition & 1 deletion packages/adapters/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Official React adapter for SmartWizard.**
React hooks (`useSmartWizard`) and Context API (`SmartWizardProvider`).

> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard).

---

Expand Down
3 changes: 2 additions & 1 deletion packages/adapters/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/adapters/react"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"license": "MIT",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
},
Expand Down
3 changes: 2 additions & 1 deletion packages/adapters/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/adapters/vue"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"license": "MIT",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**The framework-agnostic engine for SmartWizard.**
Zero dependencies · TypeScript · Accessible · Extensible · Themeable

> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard).

---

Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/core"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/extensions/swipe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Official touch swipe navigation extension for SmartWizard.**
Enables mobile and touch swipe gestures without interfering with vertical page scrolling.

> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard).

---

Expand Down
2 changes: 1 addition & 1 deletion packages/extensions/swipe/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/extensions/swipe"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/extensions/url-hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Official URL hash and browser history navigation extension for SmartWizard.**
Synchronizes active steps with `window.location.hash` and integrates with browser back/forward buttons.

> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard).

---

Expand Down
2 changes: 1 addition & 1 deletion packages/extensions/url-hash/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/extensions/url-hash"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**CSS styles, themes, and design tokens for SmartWizard.**

> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular [jQuery SmartWizard](https://github.com/techlab/jquery-smartwizard).

---

Expand Down
2 changes: 1 addition & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"url": "https://github.com/techlab/smart-wizard.git",
"directory": "packages/ui"
},
"homepage": "https://github.com/techlab/smart-wizard#readme",
"homepage": "https://techlaboratory.net/smart-wizard",
"bugs": {
"url": "https://github.com/techlab/smart-wizard/issues"
}
Expand Down
Loading