Contributing to GCM
We welcome contributions to GCM! Each component has its own contributing guide with specific development workflows and guidelines.
Component-Specific Guides
- GCM Health Checks Contributing Guide - Health check validation suite
- GCM Monitoring Contributing Guide - Monitoring collectors and exporters
- GCM GPU Metrics Contributing Guide - GPU metrics collection and processing
General Guidelines
We welcome contributions in the form of:
Pull Requests
- Fork the repo and create your feature branch from
main - If you've added code, add suitable tests
- Ensure the test suite and lint pass
- Complete the Contributor License Agreement (CLA)
Contributor License Agreement (CLA)
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Meta's open source projects.
Complete your CLA here
Issues
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to reproduce the issue.
Meta has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
License
Each GCM component has its own lincense.
/gcm is licensed under the MIT License.
/shelper is licensed under the MIT License.
/slurmprocessor is licensed under the Apache 2.0 License.
Remaining files are licensed under the MIT License.