| Summary: | Developer Patch Submission Template Improvements | ||
|---|---|---|---|
| Product: | [Documentation] Reference | Reporter: | Richard Purdie <richard.purdie> |
| Component: | handbook | Assignee: | Paul Eggleton <bluelightning> |
| Status: | RESOLVED OBSOLETE | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | Low | CC: | dvhart, jessica.zhang, poky.doc.watcher, poky.watcher, sgw |
| Version: | unspecified | ||
| Target Milestone: | 1.6 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | |||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Yes (doc changes required) | |
Accepted and reassigned to the Reference Guide (Handbook). Are our patch submission tools limited to the two scripts "create-pull-request" and "send-pull-request"? Also, if we adopt some sort of template message to be used with the scripts, what is the user model? Where and how does the user interact with the template in order to provide information? This seems like a good idea if it is implemented right. Has anyone thought more on this issue? Scott Scott, I think this needs more teamwide and community discussion. We do have "commit guidelines" on both the YP wiki and the OE wiki. There is an outstanding action for the TSC to merge those. It may well be this would be best placed into that document rather than the YP manuals. After discussion with Richard, given what we now have in the wiki / manual covering patch submission and the successful process we've established, this is obsolete. |
The OE TSC discussed improving our patch submission tools to include template messages about the kinds of things that could be included in the commit messages and pull request summary. A suggestion about what one company used is included below. This enhancement request is to investigate the possible solutions and propose something to be adopted. This would be to encourage users to include more information in commit messages including what testing had been made of patches. From $USER@${myname} ${yesterday} From: $(my_email) To: ${mailto} Cc: ${mailcc} Date: ${today} Subject: Review request 0/$patch_count: INSERT 10 WORD SUMMARY HERE [ $(squash_cq $cqid) ] Summary: Tech Review: Gatekeeper: Lockdown Approval (if needed): Branch Tag: $remotehead IP Statement (form link or license statement): Parent Template (where applicable): ------------------------------- Impacted area Impact y/n ------------------- ----------- docs/tech-pubs n tests n build system n host dependencies n RPM/packaging n toolchain n kernel code n user code n configuration files n target configuration n Other n Comments (indicate scope for each "y" above): --------------------------------------------- $(all_git_log $range) Added Files: ------------ $(files_changed added) Removed Files: -------------- $(files_changed removed) Remaining Changes (diffstat): ----------------------------- $(files_changed changed) Testing Applicable to: ---------------------- Testing, Expected Results: -------------------------- Conditions of submission: ------------------------- Arch built boot boardname ------------------------------------- MIPS n n MIPS64 n n MIPS64n32 n n ARM n n x86 n n x86_64 n n PPC n n PPC64 n n