Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.3 KB
Raw

Contributing Guide

Thank you for your interest in the shadcn/ui boilerplate! We welcome all forms of contributions, including reporting issues, submitting feature requests, and code contributions. Please follow the guidelines below to help us manage contributions effectively.

How to Contribute

1. Reporting Issues

If you encounter a bug or issue, please submit an issue on GitHub Issues. Provide the following information:

  • A description of the issue
  • Steps to reproduce the issue
  • Your operating system and browser information
  • Any relevant error messages or screenshots

2. Submitting Feature Requests

If you have a suggestion for a new feature, please submit a feature request on GitHub Issues. Be as detailed as possible about the feature you would like to add and its use case.

3. Code Contributions

If you would like to contribute code to the project, please follow these steps:

  1. Fork the Repository: Click the "Fork" button on GitHub to copy the repository to your account.
  2. Clone the Repository: Clone the repository to your local machine: 
    git clone https://github.com/your-username/shadcnui-boilerplate.git
  3. Create a Branch: Create a new branch in your local repository: 
    git checkout -b feature/your-feature-name
  4. Make Changes: Make your code changes on your branch.
  5. Commit Changes: Commit your changes to your branch: 
    git add .
git commit -m "Describe your changes"
  6. Push Changes: Push your changes to your GitHub repository: 
    git push origin feature/your-feature-name
  7. Create a Pull Request: Go to the original repository on GitHub and create a new pull request. Please describe your changes and their purpose.

Code Style

Please adhere to the following code style guidelines:

  • Use ESLint to check code quality.

Code of Conduct

Please follow the Code of Conduct to ensure our community is friendly and inclusive.

Thank You

Thank you for contributing to the shadcn/ui boilerplate! Your support helps us continuously improve and grow this project.