Skip to content

Latest commit

 

History

History
137 lines (88 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

137 lines (88 loc) · 2.88 KB

Contribution Guidelines

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.

🛠 How to Contribute

1. Fork the Repository

  1. Click the Fork button at the top right of this repository.
  2. Clone your fork to your local machine: 
    git clone https://github.com/your-username/Larvitar.git
cd Larvitar

2. Create a Branch

  • Use a descriptive name for your branch: 
    git checkout -b feature/your-feature-name

3. Make Your Changes

  • Add or modify code or documentation as needed.
  • Follow the existing code style and structure.

4. Test Your Changes

  • Ensure your changes don't break existing functionality.
  • Run the development server: 
    npm run dev
  • Verify everything works as expected.

5. Commit Your Changes

  • Write clear and concise commit messages: 
    git add .
git commit -m "Add feature X to Y"

6. Push Your Changes

  • Push your changes to your fork: 
    git push origin feature/your-feature-name

7. Open a Pull Request

  1. Go to the Pull Requests tab in this repository.
  2. Click New Pull Request.
  3. Select your branch and provide a detailed description of your changes.

📋 Code of Conduct

By contributing to this project, you agree to abide by our Code of Conduct.

🧪 Development Workflow

Install Dependencies

Run the following command to install all required dependencies:

npm ci

Start Development Server

Start the development server to preview changes:

npm run dev

Build for Production

To build the project for production:

npm run build

📝 Reporting Issues

  1. Search the existing issues to avoid duplicates.
  2. Open a new issue and provide:
    • A clear and concise title.
    • A detailed description of the issue.
    • Steps to reproduce the problem, if applicable.

📚 Submitting Documentation

  1. Update or improve the documentation located in the /docs folder.
  2. Follow the same steps to create a pull request.

🔄 Branch Naming Convention

Use the following branch naming conventions for clarity:

  • Features: feature/your-feature-name
  • Bugfixes: fix/bug-description
  • Documentation: docs/update-section-name

✅ Pull Request Checklist

Before submitting a pull request:

  1. Ensure your code is clean and follows the existing style.
  2. Include comments to explain complex logic, if applicable.
  3. Add or update tests for new functionality.

🙌 Thank You

Thank you for taking the time to contribute to Larvitar. Your efforts make this project better for everyone!