openstack/contributor-guide
Code Issues Proposed changes

Some minor docs fixes

Browse Source 
Update some outdated refs and links. Fix some formatting.

Change-Id: If9a3ff98edfdd08f88b62b12024e8f60a60d8489
This commit is contained in:
Dr. Jens Harbott
2024-08-18 16:09:37 +02:00
parent 21eca93b30
commit bfcdad4f96
2 changed files with 14 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/common/git.rst
View File

@@ -48,13 +48,9 @@ For distributions like Debian, Ubuntu, or Mint open a terminal and type::
sudo apt install git
For distributions like RedHat, Fedora 21 or earlier, or CentOS open a terminal
For distributions like RedHat, Fedora or CentOS open a terminal
and type::
sudo yum install git
For Fedora 22 or later open a terminal and type::
sudo dnf install git
For SUSE distributions open a terminal and type::
@@ -95,7 +91,7 @@ and email address. This is how your contributions will be identified::
Learning Git
------------
You can use `Git Immersion <http://gitimmersion.com/lab_02.html>`_ to work
You can use `Git Immersion <https://gitimmersion.com/index.html>`_ to work
through tutorials for learning git.
For reference, use the `Git Reference and Cheat Sheet <https://git-scm.com/doc>`_.
@@ -156,22 +152,22 @@ The following footer is required:
StoryBoard specific footers:
- ``Task``: 1234: the number of the task in Storyboard implemented by the
- ``Task: 1234``: the number of the task in Storyboard implemented by the
change. This will auto update the task to 'Review' status and assign it
to you when you push the patch.
- ``Story``: 1234567: the number of the story in Storyboard to which the task
- ``Story: 1234567``: the number of the story in Storyboard to which the task
being implemented belongs. This will post a comment on the story with a
link to your patch.
Launchpad specific footers:
- ``Closes-Bug``: #123456789: use ``Closes-Bug`` if the commit is intended to
- ``Closes-Bug: #123456789``: use ``Closes-Bug`` if the commit is intended to
fully fix and close the bug being referenced. Use the Launchpad ID of the bug
for the number; Gerrit automatically creates a link to the bug.
- ``Partial-Bug``: #123456789: use ``Partial-Bug`` if the commit is only a
- ``Partial-Bug: #123456789``: use ``Partial-Bug`` if the commit is only a
partial fix and more work is needed. Use the Launchpad ID of the bug
for the number; Gerrit automatically creates a link to the bug.
- ``Related-Bug``: #12456789: use 'Related-Bug' if the commit is merely
- ``Related-Bug: #12456789``: use ``Related-Bug`` if the commit is merely
related to the referenced bug. Use the Launchpad ID of the bug
for the number; Gerrit automatically creates a link to the bug.
- ``Partial-Implements``: Use this footer if the change partially implements
@@ -179,7 +175,6 @@ Launchpad specific footers:
- ``Implements``: Use this footer if the change fully implements
a Launchpad blueprint. Use the name of the blueprint as an ID.
The following footers are optional; however, their use is recommended if they
are applicable to the patch:

18
doc/source/common/setup-gerrit.rst
View File

@@ -98,10 +98,10 @@ to contribute.
Contributors From the U.S. Government
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#. Someone of authority needs to sign the `U.S. Government Contributor License
Agreement <https://wiki.openstack.org/wiki/GovernmentCLA>`_. Contact the
`Open Infrastructure Foundation <mailto:communitymngr@openstack.org>`_ to
initiate this process.
Someone of authority needs to sign the `U.S. Government Contributor License
Agreement <https://wiki.openstack.org/wiki/GovernmentCLA>`_. Contact the
`Open Infrastructure Foundation <mailto:communitymngr@openstack.org>`_ to
initiate this process.
Setup SSH Keys
==============
@@ -220,7 +220,7 @@ name above::
cat ~/.ssh/id_openstack_ed25519.pub
Highlight and copy the output.
Select and copy the output.
Import Public Key Into Gerrit
-----------------------------
@@ -281,13 +281,9 @@ For distributions like Debian, Ubuntu, or Mint open a terminal and type::
sudo apt install git-review
For distributions like RedHat, Fedora 21 or earlier, or CentOS open a terminal
For distributions like RedHat, Fedora or CentOS open a terminal
and type::
sudo yum install git-review
For Fedora 22 or later open a terminal and type::
sudo dnf install git-review
For SUSE distributions open a terminal and type::
@@ -319,4 +315,4 @@ to enable pushing changes to Gerrit.
.. note::
Git reviews only needs to be initialized once in a repository.
Git review only needs to be initialized once in a repository.