Message ID | 20230104100730.20425-1-pvorel@suse.cz |
---|---|
State | Accepted |
Headers | show |
Series | [1/1] github: Improve pull request template | expand |
Hi, Reviewed-by: Avinesh Kumar <akumar@suse.de> On Wednesday, January 4, 2023 3:37:30 PM IST Petr Vorel wrote: > * Signed-off-by > * code style > * links to wiki (API, maintainer checklist, ...) > * wrap text in html comments (instructions will not be visible) > > Signed-off-by: Petr Vorel <pvorel@suse.cz> > --- > .github/pull_request_template.md | 20 +++++++++++++++++--- > 1 file changed, 17 insertions(+), 3 deletions(-) > > diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md > index 477f49c6bc..1082bcdd88 100644 > --- a/.github/pull_request_template.md > +++ b/.github/pull_request_template.md > @@ -1,8 +1,22 @@ > [ type description here; PLEASE REMOVE THIS LINE AND THE LINES BELOW BEFORE SUBMITTING THIS PULL REQUEST ] > > -Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ > - > +<!-- > +* Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ > There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email). > - > LTP mailing list is archived at: https://lore.kernel.org/ltp/. > We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/. > + > +* Commits should be signed: Signed-off-by: Your Name <me@example.org>, see > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin > + > +* New code should follow Linux kernel coding style, see > +https://www.kernel.org/doc/html/latest/process/coding-style.html. > +You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors. > + > +* For more tips check > +https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist > +https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines > +https://github.com/linux-test-project/ltp/wiki/C-Test-API > +https://github.com/linux-test-project/ltp/wiki/Shell-Test-API > +https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial > +--> > Regards, Avinesh
Hello, Please merge. Acked-by: Richard Palethorpe <rpalethorpe@suse.com> Avinesh Kumar <akumar@suse.de> writes: > Hi, > > Reviewed-by: Avinesh Kumar <akumar@suse.de> > > On Wednesday, January 4, 2023 3:37:30 PM IST Petr Vorel wrote: >> * Signed-off-by >> * code style >> * links to wiki (API, maintainer checklist, ...) >> * wrap text in html comments (instructions will not be visible) >> >> Signed-off-by: Petr Vorel <pvorel@suse.cz> >> --- >> .github/pull_request_template.md | 20 +++++++++++++++++--- >> 1 file changed, 17 insertions(+), 3 deletions(-) >> >> diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md >> index 477f49c6bc..1082bcdd88 100644 >> --- a/.github/pull_request_template.md >> +++ b/.github/pull_request_template.md >> @@ -1,8 +1,22 @@ >> [ type description here; PLEASE REMOVE THIS LINE AND THE LINES BELOW BEFORE SUBMITTING THIS PULL REQUEST ] >> >> -Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ >> - >> +<!-- >> +* Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ >> There is an example how to use it: >> https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review >> (using git format-patch and git send-email). >> - >> LTP mailing list is archived at: https://lore.kernel.org/ltp/. >> We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/. >> + >> +* Commits should be signed: Signed-off-by: Your Name <me@example.org>, see >> +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin >> + >> +* New code should follow Linux kernel coding style, see >> +https://www.kernel.org/doc/html/latest/process/coding-style.html. >> +You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors. >> + >> +* For more tips check >> +https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist >> +https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines >> +https://github.com/linux-test-project/ltp/wiki/C-Test-API >> +https://github.com/linux-test-project/ltp/wiki/Shell-Test-API >> +https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial >> +--> >> > > Regards, > Avinesh
Hi Richie, Avinesh, thanks for your review. > Hello, > Please merge. Before merge, are you ok with one more change? Kind regards, Petr +++ .github/pull_request_template.md @@ -9,6 +9,11 @@ We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list * Commits should be signed: Signed-off-by: Your Name <me@example.org>, see https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin +* Commit message should be meaningful, following common style +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes +https://chris.beams.io/posts/git-commit/ + * New code should follow Linux kernel coding style, see https://www.kernel.org/doc/html/latest/process/coding-style.html. You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors.
On Tuesday, January 10, 2023 3:56:35 PM IST Petr Vorel wrote: > Hi Richie, Avinesh, > > thanks for your review. > > Hello, > > > Please merge. > Before merge, are you ok with one more change? > > Kind regards, > Petr > > +++ .github/pull_request_template.md > @@ -9,6 +9,11 @@ We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list > * Commits should be signed: Signed-off-by: Your Name <me@example.org>, see > https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin > > +* Commit message should be meaningful, following common style > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > +https://chris.beams.io/posts/git-commit/ +1 for the change, as long as the last url can be considered reliable. It already redirects to another website for me. > + > * New code should follow Linux kernel coding style, see > https://www.kernel.org/doc/html/latest/process/coding-style.html. > You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors. > Regards, Avinesh
Hello, Petr Vorel <pvorel@suse.cz> writes: > Hi Richie, Avinesh, > > thanks for your review. >> Hello, > >> Please merge. > Before merge, are you ok with one more change? Yes, although > > Kind regards, > Petr > > +++ .github/pull_request_template.md > @@ -9,6 +9,11 @@ We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list > * Commits should be signed: Signed-off-by: Your Name <me@example.org>, see > https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin > > +* Commit message should be meaningful, following common style > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > +https://chris.beams.io/posts/git-commit/ This redirects to https://cbea.ms/git-commit/. > + > * New code should follow Linux kernel coding style, see > https://www.kernel.org/doc/html/latest/process/coding-style.html. > You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors.
Hi Richie, Avinesh, > > thanks for your review. > >> Hello, > >> Please merge. > > Before merge, are you ok with one more change? > Yes, although > > Kind regards, > > Petr > > +++ .github/pull_request_template.md > > @@ -9,6 +9,11 @@ We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list > > * Commits should be signed: Signed-off-by: Your Name <me@example.org>, see > > https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin > > +* Commit message should be meaningful, following common style > > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes > > +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > > +https://chris.beams.io/posts/git-commit/ > This redirects to https://cbea.ms/git-commit/. Thank you both for additional review, I merged with the redirected URL. If not stable in the future, we can always deleted it. Kind regards, Petr
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 477f49c6bc..1082bcdd88 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,22 @@ [ type description here; PLEASE REMOVE THIS LINE AND THE LINES BELOW BEFORE SUBMITTING THIS PULL REQUEST ] -Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ - +<!-- +* Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/ There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email). - LTP mailing list is archived at: https://lore.kernel.org/ltp/. We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/. + +* Commits should be signed: Signed-off-by: Your Name <me@example.org>, see +https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin + +* New code should follow Linux kernel coding style, see +https://www.kernel.org/doc/html/latest/process/coding-style.html. +You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors. + +* For more tips check +https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist +https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines +https://github.com/linux-test-project/ltp/wiki/C-Test-API +https://github.com/linux-test-project/ltp/wiki/Shell-Test-API +https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial +-->
* Signed-off-by * code style * links to wiki (API, maintainer checklist, ...) * wrap text in html comments (instructions will not be visible) Signed-off-by: Petr Vorel <pvorel@suse.cz> --- .github/pull_request_template.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-)