Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
adam.huang
Arm Trusted Firmware
Commits
c84539f2
Commit
c84539f2
authored
Aug 17, 2020
by
Sandrine Bailleux
Committed by
TrustedFirmware Code Review
Aug 17, 2020
Browse files
Merge "doc: Refactor the contribution guidelines" into integration
parents
1b662661
e256cc63
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/process/contributing.rst
View file @
c84539f2
...
@@ -19,6 +19,7 @@ Getting Started
...
@@ -19,6 +19,7 @@ Getting Started
- Clone `Trusted Firmware-A`_ on your own machine as described in
- Clone `Trusted Firmware-A`_ on your own machine as described in
:ref:`prerequisites_get_source`.
:ref:`prerequisites_get_source`.
- Create a local topic branch based on the `Trusted Firmware-A`_ ``master``
- Create a local topic branch based on the `Trusted Firmware-A`_ ``master``
branch.
branch.
...
@@ -27,6 +28,7 @@ Making Changes
...
@@ -27,6 +28,7 @@ Making Changes
- Make commits of logical units. See these general `Git guidelines`_ for
- Make commits of logical units. See these general `Git guidelines`_ for
contributing to a project.
contributing to a project.
- Follow the :ref:`Coding Style` and :ref:`Coding Guidelines`.
- Follow the :ref:`Coding Style` and :ref:`Coding Guidelines`.
- Use the checkpatch.pl script provided with the Linux source tree. A
- Use the checkpatch.pl script provided with the Linux source tree. A
...
@@ -34,36 +36,43 @@ Making Changes
...
@@ -34,36 +36,43 @@ Making Changes
- Keep the commits on topic. If you need to fix another bug or make another
- Keep the commits on topic. If you need to fix another bug or make another
enhancement, please address it on a separate topic branch.
enhancement, please address it on a separate topic branch.
- Avoid long commit series. If you do have a long series, consider whether
- Avoid long commit series. If you do have a long series, consider whether
some commits should be squashed together or addressed in a separate topic.
some commits should be squashed together or addressed in a separate topic.
- Make sure your commit messages are in the proper format. If a commit fixes
- Make sure your commit messages are in the proper format. If a commit fixes
an `issue`_, include a reference.
an `issue`_, include a reference.
- Where appropriate, please update the documentation.
- Consider whether the :ref:`Porting Guide`,
:ref:`Firmware Design` document or other in-source documentation needs
updating.
- Ensure that each changed file has the correct copyright and license
information. Files that entirely consist of contributions to this
project should have a copyright notice and BSD-3-Clause SPDX license
identifier of the form as shown in :ref:`license`. Files that contain
changes to imported Third Party IP files should retain their original
copyright and license notices. For significant contributions you may
add your own copyright notice in following format:
::
-
Where appropriate, please update the documentation.
Portions copyright (c) [XXXX-]YYYY, <OWNER>. All rights reserved.
- Consider whether the :ref:`Porting Guide`, :ref:`Firmware Design` document
or other in-source documentation needs updating.
where XXXX is the year of first contribution (if different to YYYY) and
YYYY is the year of most recent contribution. <OWNER> is your name or
your company name.
- If you are submitting new files that you intend to be the code owner for
- If you are submitting new files that you intend to be the code owner for
(for example, a new platform port), then also update the
(for example, a new platform port), then also update the
:ref:`code owners` file.
:ref:`code owners` file.
- For topics with multiple commits, you should make all documentation
changes (and nothing else) in the last commit of the series. Otherwise,
- For topics with multiple commits, you should make all documentation changes
include the documentation changes within the single commit.
(and nothing else) in the last commit of the series. Otherwise, include
the documentation changes within the single commit.
- Ensure that each changed file has the correct copyright and license
information. Files that entirely consist of contributions to this project
should have a copyright notice and BSD-3-Clause SPDX license identifier of
the form as shown in :ref:`license`. Files that contain changes to imported
Third Party IP files should retain their original copyright and license
notices.
For significant contributions you may add your own copyright notice in the
following format:
::
Portions copyright (c) [XXXX-]YYYY, <OWNER>. All rights reserved.
where XXXX is the year of first contribution (if different to YYYY) and YYYY
is the year of most recent contribution. <OWNER> is your name or your company
name.
- Please test your changes. As a minimum, ensure that Linux boots on the
- Please test your changes. As a minimum, ensure that Linux boots on the
Foundation FVP. See :ref:`Arm Fixed Virtual Platforms (FVP)` for more
Foundation FVP. See :ref:`Arm Fixed Virtual Platforms (FVP)` for more
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment