Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.68 KB

Contributing to FlagCX

Thanks for your interest in contributing to FlagCX! Here's how to get involved.

Reporting Issues

Open an issue on GitHub Issues with:

  • A clear title and description
  • Steps to reproduce the problem
  • Expected vs. actual behavior
  • Environment details (OS, hardware, driver versions)

Contributing Code

  1. Fork the repo and create a branch from main.
  2. Make your changes — keep commits focused and well-described.
  3. Add or update tests in the test/ directory if applicable.
  4. Make sure the project builds cleanly (make at the repo root).
  5. Open a pull request against main with a summary of what changed and why.

Please follow the Code of Conduct in all interactions.

Documentation

Project Structure

flagcx/          — core library (adaptor, core, kernels, runner, service)
adaptor_plugin/  — example adaptor plugin implementation and usage
plugin/          — plugins for integrating with upper-level frameworks or applications
test/            — test suites
docs/            — documentation
makefiles/       — build system helpers
packaging/       — packaging scripts
third-party/     — third-party dependencies

License

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