Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

60 lines (37 loc) · 1.76 KB
Raw

Contributing to Qwik-Sonner

Thank you for considering contributing to Qwik-Sonner! This library provides toast notifications for seamless user feedback.

To contribute, please follow these guidelines:

Getting Started

  1. Fork the Qwik-Sonner repository on GitHub.
  2. Clone the forked repository to your local machine.
git clone https://github.com/your-username/qwik-sonner.git
  1. Create a new branch to work on. The branch name should briefly describe the changes you're making.
git checkout -b feature/your-change

Making Changes

  • If you are making general changes, describe them in the branch name.
  • If you are working on the website, add "website" after the verb in the branch name.

Example:

  • feature/update-readme
  • feature-website/add-new-feature

Commit Messages

For commit messages, use Conventional Commits format. If you're making changes to the website, include the "website" scope.

Visual Studio Code Setup

For an optimal development experience, use the extensions provided in the .vscode folder. Additionally, execute the Conventional Commits extension to follow the commit message conventions.

Creating a Pull Request

  1. Push your changes to your forked repository.
git push origin feature/your-change
  1. Create a Pull Request (PR) on the original Qwik-Sonner repository.

Make sure to include:

  • A descriptive title for your PR.
  • Details about the changes made.
  • Any relevant context or motivation.
  • Mention if a package version update is needed and explain the reasons.

Versioning

If your changes require a package version update, clearly state it in the PR. Provide reasons and justifications for the version update.

Thank you for your contribution! 🚀