First off, thank you for considering contributing to SupaSvelteKit! 🎉 Every contribution, whether it's a small typo fix or a new feature, is invaluable to the project's growth. This document provides guidelines and steps for contributing.
By participating in this project, you're expected to uphold our Code of Conduct. Please ensure you read and understand its contents.
- Ensure the bug hasn't been reported already by searching the issues.
- If you can't find an existing issue, open a new one. Be sure to include a clear title, a detailed description, and as much relevant information as possible.
- First, read the documentation to ensure the enhancement isn't already a feature.
- Open a new issue and label it as an enhancement.
- Provide a clear and detailed explanation of the enhancement and its benefits.
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push the branch:
git push origin feature/your-feature-name. - Submit a pull request.
- Clone the repository:
git clone https://github.com/your-username/SupaSvelteKit.git. - Navigate to the project directory:
cd SupaSvelteKit. - Install dependencies:
npm install. - Start the development server:
npm run dev.
- Ensure your code follows the established coding style of the project.
- Comment your code where necessary.
- Write tests for new features or bug fixes.
Contributors will be recognized in the project's README and on the project's website (if applicable).
Thank you for making SupaSvelteKit even better! 🌟 Your efforts and contributions are deeply appreciated.