Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (59 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

91 lines (59 loc) · 1.95 KB
Raw

Contributing to @project-eleven/libqc

Thanks for your interest! We welcome pull requests, issues, and feedback. Here’s how you can help.

Reporting Issues

  • Open an issue on GitHub.
  • Give a clear title.
  • Describe the problem, steps to reproduce, and expected outcome.
  • Attach code snippets or error messages when you can.

Suggesting New Features

  • Open an issue first to discuss ideas.
  • Explain the use case and why it is necessary.
  • We’ll review and suggest next steps before you write code.

Pull Requests

  1. Fork the repo and clone your fork.

  2. Create a branch:

git checkout -b <feature|fix|chore>/title
  1. Implement your change.

4.Format your code:

pnpm run prettier:check
pnpm run prettier:fix
  1. Lint your code:
pnpm run lint:check
pnpm run lint:fix
  1. Run tests and add new ones if needed:
pnpm run test
  1. Commit your changes:
git add .
git commit -m "feat: add new feature"
  1. Push to your fork:
git push origin <feature|fix|chore>/title
  1. Create a pull request on GitHub against the main branch.
  • Make sure to include a clear description of your changes and why they are necessary.
  • Link to open issues that this PR addresses.
  1. Review and merge:
  • Wait for feedback from maintainers.
  • Address any comments or concerns.
  • Once approved, we will merge your PR.

Code Style

  • Follow TypeScript idioms and existing patterns.
  • Keep functions small and focused.
  • Use clear names and short sentences in comments.

Testing

  • All functions should have tests.
  • Strive for edge-case coverage.

Security

If you find a security issue or vulnerability, please don’t open a public issue. Instead, email the maintainers at support@projecteleven.com with details. We’ll acknowledge and fix it ASAP.

License

By contributing, you agree that your work will be licensed under the MIT License see LICENSE.