Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.84 KB

Contributing to OneCLI

Thank you for your interest in contributing to OneCLI! We'd love to have you contribute. Here are some resources and guidance to help you get started.

Getting Started

To ensure a positive and inclusive environment, please read our Code of Conduct before contributing.

Local Development Setup

git clone https://github.com/onecli/onecli.git
cd onecli
pnpm install
cp .env.example .env
pnpm db:generate
pnpm dev

See the README for more details on prerequisites and configuration.

Issues

If you find a bug, please create an issue and we'll triage it.

  • Please search existing issues before creating a new one.
  • Please include a clear description of the problem along with steps to reproduce it. Screenshots and URLs really help.

Pull Requests

We actively welcome your Pull Requests! A couple of things to keep in mind before you submit:

  • If you're fixing an issue, make sure someone else hasn't already created a PR fixing the same issue. Link your PR to the related issue(s).
  • If you're new, we encourage you to take a look at issues tagged with good first issue.
  • If you're submitting a new feature, please open an issue first to discuss it before opening a PR.

Before submitting your PR, please run these checks locally:

pnpm build     # Ensure the project builds
pnpm check     # Lint + types + format

Running these before you create the PR will help reduce back and forth during review.

License

By contributing to OneCLI, you agree that your contributions will be licensed under the Apache License 2.0.