Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 1.56 KB

Contributing

Welcome! We appreciate your interest in contributing.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/your-username/your-project.git
  3. Create a new branch for your changes:

    git checkout -b feat/your-feature
  4. Make your changes and add changesets summary for your change:

    pnpm changeset
  5. Commit your changes:

    git add .
    git commit -m "Your descriptive commit message"
  6. Push the changes to your GitHub repository:

    git push origin feature/your-feature
  7. Open a pull request (PR) from your branch to the main repository's main or master branch.

  8. Follow the PR template provided in PULL_REQUEST_TEMPLATE.md.

Code Style

Please follow the coding standards defined in the project. If there are no specific guidelines, maintain consistency with the existing code.

Testing

If your contribution involves code changes, make sure to add or update tests to cover the new functionality or changes.

Reporting Issues

If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

Code of Conduct

This project follows a Code of Conduct. By participating, you agree to uphold this code.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing to [Your Project Name]!