apache / apache/teaclave-trustzone-sdk
Proposal: Enforce Commit Identity Consistency
- Dominant language
- Rust
- Stars
- 284
- Forks
- 83
- Avg merge
- 3h 34m
- Merged PRs (30d)
- 6
Description
In recent pre-release wrap-up, we discovered that new contributors were not being counted by the statistics. For example, in [#201](https://github.com/apache/incubator-teaclave-trustzone-sdk/pull/201), we noticed this was caused by inconsistencies between the GitHub user who submitted the pull request and the commit metadata. For instance, the PR was authored by `x1a0b0`, but the commit showed `Author: zengxiaobo` and `Signed-off-by: x1a0b0 `. This mismatch often occurs when the local Git configuration (`user.name` and `user.email`) doesn't align with the contributor’s GitHub account, or when a maintainer merges or rebases the commit without preserving the original author.
While these issues are usually harmless, they make it harder to trace contributions and verify provenance. Ideally, such inconsistencies should be automatically detected before merging into `main`.
To address this, we suggest adopting the tools like `DCO`, `commitlint`, `Verified Github Author Action`, which help automatically verify that each commit includes a valid `Signed-off-by` line and that it matches the commit author, helping catch these issues early. This lightweight, widely adopted tool integrates easily with our existing pull request workflow.
We welcome anyone interested in helping implement this to contribute. The setup is straightforward, and we’d also benefit from a small update to the `CONTRIBUTING` section of our `README.md` to document the signing requirement (`git commit -s`). Please let us know if you’d like to take this on or collaborate on the integration.
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the repository's existing pull request workflow and the CONTRIBUTING section of README.md first. Compare DCO, commitlint, and Verified GitHub Author Action against the requested author and Signed-off-by checks, then document the signing requirement and verify that the workflow catches mismatched commit identity before merging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- ci-cd, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100