Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (29 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.61 KB

Contributing to Mehaisi CodeSwarm

First off, thank you for considering contributing to Mehaisi CodeSwarm! It's people like you that make Mehaisi CodeSwarm such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported by searching on GitHub under Issues.
  • If you can't find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a GitHub Issue with the tag enhancement.
  • Describe the feature and why it would be useful.

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 (npm test).
  5. Make sure your code lints (npm run lint).
  6. Issue that Pull Request!

Style Guide

  • Use semicolon-less or semicolon style? (Project uses semicolons, see existing code).
  • Follow the existing coding style and patterns.
  • Write clear, commented (where necessary) code.

Testing

Always run the full test suite before submitting a PR:

npm test

Questions?

Feel free to open an issue with the tag question.