| Message ID | 20221212131138.26544-1-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | e653f4c13e32225c2d1c304f3e6c44ff4efbdfe9 |
| Headers | show |
| Series |
|
| Related | show |
Quoting Laurent Pinchart via libcamera-devel (2022-12-12 13:11:38) > All developers, whether junior or experienced, can benefit from > improving their commit message writing skills. Add a paragraph to the > contribution documentation to explain this, with a link to a good guide. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Sounds good to me. Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> > --- > Documentation/contributing.rst | 7 +++++++ > 1 file changed, 7 insertions(+) > > diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst > index 6405c5fb8a1a..2f0b4921f7e6 100644 > --- a/Documentation/contributing.rst > +++ b/Documentation/contributing.rst > @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is > made possible by a set of :ref:`coding-style-guidelines` that all submissions > are expected to follow. > > +We also care about the quality of commit messages. A good commit message not > +only describes what a commit does, but why it does so. By conveying clear > +information about the purpose of the commit, it helps speeding up reviews. > +Regardless of whether you're new to git or have years of experience, > +https://cbea.ms/git-commit/ is always a good guide to read to improve your > +commit message writing skills. > + > The patch submission process for libcamera is similar to the Linux kernel, and > goes through the `libcamera-devel`_ mailing list. If you have no previous > experience with ``git-send-email``, or just experience trouble configuring it > > base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e > prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 > prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb > prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 > prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d > -- > Regards, > > Laurent Pinchart >
Hello, On 12/12/22 7:08 PM, Kieran Bingham via libcamera-devel wrote: > Quoting Laurent Pinchart via libcamera-devel (2022-12-12 13:11:38) >> All developers, whether junior or experienced, can benefit from >> improving their commit message writing skills. Add a paragraph to the >> contribution documentation to explain this, with a link to a good guide. >> >> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > Sounds good to me. > > > Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Seconded, Reviewed-by: Umang Jain <umang.jain@ideasonboard.com> > >> --- >> Documentation/contributing.rst | 7 +++++++ >> 1 file changed, 7 insertions(+) >> >> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst >> index 6405c5fb8a1a..2f0b4921f7e6 100644 >> --- a/Documentation/contributing.rst >> +++ b/Documentation/contributing.rst >> @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is >> made possible by a set of :ref:`coding-style-guidelines` that all submissions >> are expected to follow. >> >> +We also care about the quality of commit messages. A good commit message not >> +only describes what a commit does, but why it does so. By conveying clear >> +information about the purpose of the commit, it helps speeding up reviews. >> +Regardless of whether you're new to git or have years of experience, >> +https://cbea.ms/git-commit/ is always a good guide to read to improve your >> +commit message writing skills. >> + >> The patch submission process for libcamera is similar to the Linux kernel, and >> goes through the `libcamera-devel`_ mailing list. If you have no previous >> experience with ``git-send-email``, or just experience trouble configuring it >> >> base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e >> prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 >> prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb >> prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 >> prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d >> -- >> Regards, >> >> Laurent Pinchart >>
Dear Laurent, The git history contains "tags" in the commit message header, e.g.: - libcamera: pipeline: - pipeline: rkisp1: - utils: tuning: libtuning: - utils: libtuning: modules: alsc: The pattern behind those tags is not (yet) obvious to me, e.g. why is it "pipeline: rkisp1:" and not "libcamera: pipeline: rkisp1:". Could you also add some documentation on how those tags should be selected? Best, Christian Am 12.12.22 um 14:11 schrieb Laurent Pinchart via libcamera-devel: > All developers, whether junior or experienced, can benefit from > improving their commit message writing skills. Add a paragraph to the > contribution documentation to explain this, with a link to a good guide. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > --- > Documentation/contributing.rst | 7 +++++++ > 1 file changed, 7 insertions(+) > > diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst > index 6405c5fb8a1a..2f0b4921f7e6 100644 > --- a/Documentation/contributing.rst > +++ b/Documentation/contributing.rst > @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is > made possible by a set of :ref:`coding-style-guidelines` that all submissions > are expected to follow. > > +We also care about the quality of commit messages. A good commit message not > +only describes what a commit does, but why it does so. By conveying clear > +information about the purpose of the commit, it helps speeding up reviews. > +Regardless of whether you're new to git or have years of experience, > +https://cbea.ms/git-commit/ is always a good guide to read to improve your > +commit message writing skills. > + > The patch submission process for libcamera is similar to the Linux kernel, and > goes through the `libcamera-devel`_ mailing list. If you have no previous > experience with ``git-send-email``, or just experience trouble configuring it > > base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e > prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 > prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb > prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 > prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d
Quoting Christian Rauch via libcamera-devel (2022-12-12 19:35:02) > Dear Laurent, > > The git history contains "tags" in the commit message header, e.g.: > - libcamera: pipeline: > - pipeline: rkisp1: > - utils: tuning: libtuning: > - utils: libtuning: modules: alsc: > > The pattern behind those tags is not (yet) obvious to me, e.g. why is it > "pipeline: rkisp1:" and not "libcamera: pipeline: rkisp1:". Could you > also add some documentation on how those tags should be selected? There's no formal definition here I think. It's usually 'obvious' by looking at the history of the files being changed. Sometimes it's difficult if the patch covers multiple areas too. But generally it's the 'component' name. Sometimes it makes sense to leave a tag out because otherwise the subject line would become too long. The 'libcamera:' prefix on pipeline: rkisp1: could be implicit, so it's easy to drop. Adding a phrase or two like this to the contributing.rst could indeed make sense. -- Kieran > > Best, > Christian > > > Am 12.12.22 um 14:11 schrieb Laurent Pinchart via libcamera-devel: > > All developers, whether junior or experienced, can benefit from > > improving their commit message writing skills. Add a paragraph to the > > contribution documentation to explain this, with a link to a good guide. > > > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > > --- > > Documentation/contributing.rst | 7 +++++++ > > 1 file changed, 7 insertions(+) > > > > diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst > > index 6405c5fb8a1a..2f0b4921f7e6 100644 > > --- a/Documentation/contributing.rst > > +++ b/Documentation/contributing.rst > > @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is > > made possible by a set of :ref:`coding-style-guidelines` that all submissions > > are expected to follow. > > > > +We also care about the quality of commit messages. A good commit message not > > +only describes what a commit does, but why it does so. By conveying clear > > +information about the purpose of the commit, it helps speeding up reviews. > > +Regardless of whether you're new to git or have years of experience, > > +https://cbea.ms/git-commit/ is always a good guide to read to improve your > > +commit message writing skills. > > + > > The patch submission process for libcamera is similar to the Linux kernel, and > > goes through the `libcamera-devel`_ mailing list. If you have no previous > > experience with ``git-send-email``, or just experience trouble configuring it > > > > base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e > > prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 > > prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb > > prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 > > prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d
diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index 6405c5fb8a1a..2f0b4921f7e6 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -68,6 +68,13 @@ code that is as easy to read, understand and maintain as possible. This is made possible by a set of :ref:`coding-style-guidelines` that all submissions are expected to follow. +We also care about the quality of commit messages. A good commit message not +only describes what a commit does, but why it does so. By conveying clear +information about the purpose of the commit, it helps speeding up reviews. +Regardless of whether you're new to git or have years of experience, +https://cbea.ms/git-commit/ is always a good guide to read to improve your +commit message writing skills. + The patch submission process for libcamera is similar to the Linux kernel, and goes through the `libcamera-devel`_ mailing list. If you have no previous experience with ``git-send-email``, or just experience trouble configuring it
All developers, whether junior or experienced, can benefit from improving their commit message writing skills. Add a paragraph to the contribution documentation to explain this, with a link to a good guide. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- Documentation/contributing.rst | 7 +++++++ 1 file changed, 7 insertions(+) base-commit: b026e4a6a0a620ce994938c3d1babd3f3df4a47e prerequisite-patch-id: ef2a8b4c18a2688014681a8f75d7ceddaed07b99 prerequisite-patch-id: 7b397e1ed4feed4d64faf71370fc3df4a46bb2eb prerequisite-patch-id: b7d57dd39a032a92e05d3d4e22bb821b085e2291 prerequisite-patch-id: 05daa092b096bd8385c1ca3587e344570724308d