We welcome contributions to Larvitar! Whether you're reporting a bug, suggesting a feature, improving documentation, or contributing code, your help is greatly appreciated.
Please take a moment to review these guidelines to make the contribution process smooth and effective for everyone.
- Click the Fork button at the top right of this repository.
- Clone your fork to your local machine:
git clone https://github.com/your-username/Larvitar.git cd Larvitar
- Use a descriptive name for your branch:
git checkout -b feature/your-feature-name
- Add or modify code or documentation as needed.
- Follow the existing code style and structure.
- Ensure your changes don't break existing functionality.
- Run the development server:
yarn run dev
- Verify everything works as expected.
- Write clear and concise commit messages:
git add . git commit -m "Add feature X to Y"
- Push your changes to your fork:
git push origin feature/your-feature-name
- Go to the Pull Requests tab in this repository.
- Click New Pull Request.
- Select your branch and provide a detailed description of your changes.
By contributing to this project, you agree to abide by our Code of Conduct.
Run the following command to install all required dependencies:
yarn install
Start the development server to preview changes:
yarn run dev
To build the project for production:
yarn run build
- Search the existing issues to avoid duplicates.
- Open a new issue and provide:
- A clear and concise title.
- A detailed description of the issue.
- Steps to reproduce the problem, if applicable.
- Update or improve the documentation located in the
/docs
folder. - Follow the same steps to create a pull request.
Use the following branch naming conventions for clarity:
- Features:
feature/your-feature-name
- Bugfixes:
fix/bug-description
- Documentation:
docs/update-section-name
Before submitting a pull request:
- Ensure your code is clean and follows the existing style.
- Include comments to explain complex logic, if applicable.
- Add or update tests for new functionality.
Thank you for taking the time to contribute to Larvitar. Your efforts make this project better for everyone!