Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (69 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

97 lines (69 loc) · 2.92 KB

Contributing to Vercube

Thank you for your interest in contributing to Vercube! 💜

This document provides guidelines and instructions for contributing to our project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of differing viewpoints and experiences.

How to Contribute

Reporting Bugs

  • Check if the bug has already been reported in the Issues section
  • If not, create a new issue with:
    • A clear, descriptive title
    • Detailed steps to reproduce the bug
    • Expected behavior
    • Actual behavior
    • Screenshots if applicable
    • Environment details (OS, Node.js version, etc.)
    • Reproduction link (using StackBlitz or other online web container)

Suggesting Enhancements

  • Check if the enhancement has already been suggested in the Issues section
  • Create a new issue with:
    • A clear, descriptive title
    • Detailed description of the proposed enhancement
    • Use cases and examples
    • Any relevant technical considerations
    • Reproduction link (using StackBlitz or other online web container)

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests to ensure your changes don't break existing functionality
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

  1. Clone the repository:

    git clone https://github.com/vercube/vercube.git
cd vercube

  2. Install dependencies:

    pnpm install

  3. Run tests:

    pnpm test

  4. Start the playground:

    pnpm playground

    The playground is a development environment where you can test your changes in real-time. It provides a sandbox environment to experiment with Vercube features and test your modifications before submitting a pull request.

Coding Standards

  • Follow the existing code style and formatting
  • Write clear, descriptive commit messages
  • Include tests for new features
  • Update documentation as needed
  • Keep pull requests focused and manageable

Documentation

  • Update README.md if needed
  • Add or update documentation for new features
  • Ensure code comments are clear and helpful
  • Update API documentation if you modify endpoints

Getting Help

  • Join our Discord server for real-time discussions
  • Check existing issues and pull requests
  • Ask questions in the issues section

Recognition

Contributors will be recognized in our project documentation and release notes. Significant contributions may be highlighted in our blog or social media channels.

Thank you for contributing to Vercube! Your contributions help make this project better for everyone.