Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (53 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 1.71 KB
Raw

Contributing to Starkweb

First off, thanks for taking the time to contribute!

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

Getting Started

  1. Fork the repo
  2. Clone your fork
  3. Install dependencies: pnpm install
  4. Create a branch for your changes
  5. Make your changes
  6. Run build: pnpm build

Development Process

  1. Set up your development environment:

    pnpm install

  2. Make sure your code follows our style guide:

    • Use TypeScript
    • Follow existing code formatting
    • Add appropriate tests
    • Update documentation as needed

  3. Run the test suite:

    pnpm test

Submitting Changes

  1. Push to your fork
  2. Submit a pull request
  3. Include a clear description of the changes
  4. Link any relevant issues

Bug Reports

When filing an issue, please include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Version information
  • Code samples if applicable

Feature Requests

We welcome feature requests! Please include:

  • Clear use case
  • Expected behavior
  • Why this would be beneficial to the project

Questions? Feel free to open an issue or reach out to the maintainers.