Message-ID: <1635138418.377808.1711643146503.JavaMail.root@confluence-doc2-production> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_377807_70976912.1711643146497" ------=_Part_377807_70976912.1711643146497 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
In the past, we used to have only one commit by pull request. This was a=
bad habit. We now require contributors to make atomic commits, so you will surely have more than one commit in a single pull request=
. This will be helpful to review, cherry-pick or revert (we hope to never h=
ave to do that ) the changes.<=
/p>
What=E2=80=99s an atomic commit? It means that the comm=
it=E2=80=99s purpose is one, and only one, complete fix or change=
strong>. Typically, ask yourself if what you are doing is one or several ta=
sks. Do not hesitate to use =E2=80=9Cgit add -p =E2=80=A6=E2=80=9D (details=
here) if you have made several =
changes in the same file but not all those changes are meant to be in the c=
urrent commit. When you are modifying CSS and/or JavaScript files, we invite you to mak=
e a separate commit for the compiled files. If you want to know more about =
compiling assets, you can look at our documentation. The commit name should also give an idea of the context or of the file t=
hat is being changed. The more details, the better! The commit name should =
be as unique and recognizable as your commit itself. To make the commits context easier to read and hassle-free, we have chos=
en to prefix them with two letters depending on the modification scope: Examples: Now that you have made atomic commits, you surely have a lot of commits =
for one pull request. A pull request answers to a given issue. Do not ever =
make a single pull request for many purposes. Do not hesitate to split your=
big commit into several subprojects. It will be easier and quicker to revi=
ew. As all your commits messages are well-formated, just make a summary of y=
our pull request=E2=80=99s purpose in its GitHub title. A summary does not =
mean it can not be explicit. Please describe what your pull request does in=
details (avoid =E2=80=9CFix product page=E2=80=9D or =E2=80=9CCategory pag=
e improvement=E2=80=9D). Then, just fill the PR template table to answer so=
me questions which will help the team make a decision faster. Please note that all the pull requests must follow thos=
e guidelines. If the commit messages are not well-formatted, the pull reque=
st=E2=80=99s title is not correct, or the table is not properly filled, we =
will not be able to accept your pull request. Find more information and all the details on our documentation.
Code
Scope
FO
if the changes impac=
t the front office
BO
if the changes impac=
t the back office
IN
if the changes impac=
t the installer
WS
if the changes impac=
t the web service
CO
if the changes impac=
t the core
TE
if the changes impac=
t the tests
Pull Requests<=
/h3>