Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

79 lines (60 loc) · 2.52 KB

Contributing to Avec

We love your input! We want to make contributing to Avec as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Development Process

  1. Clone the repository
  2. Install dependencies with pnpm install
  3. Create a new branch for your feature
  4. Make your changes
  5. Run tests and linting
  6. Submit a pull request

Setting Up Development Environment

  1. Copy .env.example to .env and update variables
  2. Initialize databases: 
    pnpm db:push
  3. Start development servers: 
    pnpm dev

Code Style

  • Use TypeScript
  • Follow the existing code style
  • Use meaningful variable names
  • Add comments for complex logic
  • Keep functions small and focused

Testing

  • Write unit tests for new features
  • Ensure existing tests pass
  • Test edge cases
  • Add integration tests where appropriate

License

By contributing, you agree that your contributions will be licensed under its MIT License.