1.3 KiB
1.3 KiB
Contributing
Please use this guide before making any contributions to this repository.
Preliminary
- All code must be
gofmt'd,golint'd andgo vet'd before being committed. - Code should have test coverage to ensure its correctness.
PRs
Commits
Keep individual commits descriptive. Prefix them with the collector name and a colon. Anyone viewing the git history should be able to determine from those first 80 characters, the body of the commit. Feel free to expand further on the commit but keep the first 80 characters on point.
Good Commit:
monitor: expose metrics for clock skew
- scrape monitor's skew value from ceph's status
Bad Commit:
new monitor metrics
Use your own discretion when deciding whether or not to squash multiple commits in a PR to a single commit. However, each commit should contain a single, logical unit of change, and a descriptive message.