2025-06-12 16:35:23 -03:00
|
|
|
# Contribution Guidelines
|
|
|
|
|
|
|
|
|
|
1. All commits need a sign-off by the author (except for drafts)
|
|
|
|
|
If additional reviewers gave their ack, a proper attribution
|
|
|
|
|
header may be added.
|
|
|
|
|
|
2025-07-27 01:02:40 +05:30
|
|
|
2. Commit messages should explain what's really done here, and their
|
|
|
|
|
headlines need a short and precise subject. See history for examples.
|
2025-06-12 16:35:23 -03:00
|
|
|
|
|
|
|
|
Keep in mind that history is also a piece of documentation.
|
|
|
|
|
|
2025-07-27 01:02:40 +05:30
|
|
|
3. Once a release is out, bugfixes should be submitted separately, against
|
2025-06-21 11:23:30 -06:00
|
|
|
the affected release branch(es) as well as master (so multiple pull requests)
|
2025-06-12 16:35:23 -03:00
|
|
|
|
|
|
|
|
4. If new functions or types are introduced, these should be documented
|
|
|
|
|
in-code, so we can generate docs directly from the code :)
|
|
|
|
|
|
2025-06-21 11:23:30 -06:00
|
|
|
5. Use pull request tags if you can - if we need some more, just ask.
|