openstack/training-guides
Code Issues Proposed changes

[upstream] Minor polish in module 19

Browse Source 
- address review comments in https://review.openstack.org/#/c/366255/
- add '$' prompt in code blocks
- better URL display in page 3: "Getting to Know Your Project"
- divides into two "General Contribution Workflow" pages
  (Contents are too much not to cover with just one page.)

Change-Id: I0ba424af517037dda9e9c80a3c9d444a1cf73cc0
This commit is contained in:
Ian Y. Choi
2016-09-23 00:56:01 +09:00
parent a40be14f66
commit dce7b520c9
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/upstream-training/source/19-training-contribution-process.rst
View File

@@ -20,18 +20,17 @@ Getting to Know Your Project
.. code-block:: console .. code-block:: console
git clone git://git.openstack.org/openstack/<your_project> $ git clone git://git.openstack.org/openstack/<your_project>
- Example: - Example:
.. code-block:: console .. code-block:: console
git clone git://git.openstack.org/openstack/training-guides $ git clone git://git.openstack.org/openstack/training-guides
- Run the tests - Run the tests
- Join the project's the IRC channel - Join the project's IRC channel
https://wiki.openstack.org/wiki/IRC - https://wiki.openstack.org/wiki/IRC
- Look at open reviews - Look at open reviews
- Join the openstack-dev mailing list - Join the openstack-dev mailing list
@@ -39,7 +38,8 @@ Interacting with the Project
============================ ============================
- Talking in the IRC channel - Talking in the IRC channel
- Follow and participate in project related mail threads in the mailing list - Following and participating in project related mail threads
in the mailing list
- Attending regular meetings - Attending regular meetings
- Filing, fixing, and triaging bugs - Filing, fixing, and triaging bugs
- Filing a blueprint/spec - Filing a blueprint/spec
@@ -51,10 +51,17 @@ General Contribution Workflow
- Pick a task (bug, trivial fix, documentation, implementation) - Pick a task (bug, trivial fix, documentation, implementation)
- Make a new branch in your local repository - Make a new branch in your local repository
git checkout -b name_whatever_you_want .. code-block:: console
$ git checkout -b name_whatever_you_want
- Make code changes - Make code changes
- Update and add tests (unit, functional, etc.) - Update and add tests (unit, functional, etc.)
- Run tests (unit, functional, etc.) - Run tests (unit, functional, etc.)
General Contribution Workflow
=============================
- Create your commit - Create your commit
- Add files to your commit - Add files to your commit
- Commit added files and explain changes in the commit message - Commit added files and explain changes in the commit message