Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (18 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.16 KB
Raw

Contributing to VMPrint

Thank you for your interest in VMPrint! We welcome contributions to improve the engine, the CLIs, and the documentation.

How to Contribute

  1. Report Bugs: Use the GitHub issue tracker to report bugs. Please include a reproduction case if possible (e.g., a .json or .md file that causes the issue).
  2. Suggest Features: We're open to ideas! Open an issue to discuss new features.
  3. Submit Pull Requests:
    • Fork the repository.
    • Create a new branch for your changes.
    • Ensure your code follows the existing style.
    • Add tests for any new functionality or bug fixes.
    • Run the existing tests to ensure no regressions: npm test --workspaces.
    • Submit a PR with a clear description of your changes.

Development Setup

See the Quickstart guide for instructions on setting up the monorepo and running tests.

Architecture

Before making significant changes to the engine, please review the Engine Internals Documentation.

License

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