AGENTS.md: document the enforced commit conventions#2418
AGENTS.md: document the enforced commit conventions#24180x1 (EmbeddedAndroid) wants to merge 2 commits into
Conversation
3e5f3d4 to
047502e
Compare
Going back over the last year of reviews, several conventions that the maintainers enforce are not written down here. Add them alongside the existing commit-message guidance: the Signed-off-by identity must match the author and be a real, routable address rather than a GitHub web-editor noreply; subjects use a lowercase component prefix rather than Conventional Commits or kernel-tree prefixes; branches are rebased on master rather than merged; and added patch files carry an Upstream-Status header. Writing these down keeps commits consistent and is the groundwork for enforcing the deterministic subset automatically later on. Signed-off-by: Tyler Baker <tyler.baker@oss.qualcomm.com>
047502e to
c43fdd6
Compare
|
As you are writing the docs, would you also mind a human-targeted set of recommendations to author the commits?
|
The rules above list what is rejected, but do not give a human a short set of recommendations for writing a good commit and series. Add one: keep each commit atomic, start the message with the problem being solved, keep a valid Signed-off-by chain, add your own sign-off when you pick or apply someone else's commit, and use git cherry-pick -x for backports. Signed-off-by: Tyler Baker <tyler.baker@oss.qualcomm.com>
Good idea, added as 2b91af9 |
| commits in a pull request are rejected. | ||
| - Every patch file added under a recipe must carry an `Upstream-Status:` header | ||
| with a valid value (`Submitted`, `Backport`, `Pending`, `Inappropriate`, | ||
| `Denied`, `Accepted`). |
There was a problem hiding this comment.
Here we should include all the valid patterns, and it is missing Inactive-Upstream.
I would prefer if we could keep this part outside AGENTS.md, as this is for humans and it contains a bit of duplication, which would just burn tokens. We could extend https://github.com/qualcomm-linux/meta-qcom/blob/master/README.md#contributing or just add a new entry at https://github.com/qualcomm-linux/meta-qcom/tree/master/docs. |
|
I think a separate document is the best idea. |
|
Granted the lack of updates for 3 weeks I've proposed #2652 |
Since that one has been merged, can this PR be closed? |
Going back over the last year of reviews, I noticed several conventions that the maintainers enforce which are not written down in our new
Agents.md. Add them alongside the existing commit-message guidance:I'm happy to adjust if some of these rules seem too strict.
Writing these down keeps commits consistent and is the groundwork for enforcing the deterministic subset automatically in the very short future.