starlingx/docs
Code Issues Proposed changes

Adding information about Opendev infra to the StarlingX docs

Browse Source 
This review adds information about the service-discuss mailing list
to the Contributor's Guide.
Review updates based on patchset 1 comments.

Closes-Bug: 2009185

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I8b8e3dec17fd285e288aaa24c0a48cd6fc82068c
This commit is contained in:
Ron Stone 2023-03-08 17:41:54 +00:00
parent dac7b89c00
commit 3eadca9791
1 changed files with 61 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
doc/source/contributor/development_process.rst
View File

@ -541,48 +541,63 @@ Testing phase
************* *************
Testing a newly developed fix or feature can be as challenging as developing Testing a newly developed fix or feature can be as challenging as developing
the fix or feature itself. The effort and work items needed to complete the fix or feature itself. The effort and work items needed to complete the
the testing phase should be considered in the planning phase. testing phase should be considered in the planning phase.
It is possible to cause major changes in the It is possible to cause major changes in the behavior of the StarlingX software
behavior of the StarlingX software
with very small code changes so thorough testing is important to the stability with very small code changes so thorough testing is important to the stability
of the code. We suggest that feature developers create a test plan of the code. We suggest that feature developers create a test plan in
in collaboration with the sub-project's PL and TL, the core reviewers collaboration with the sub-project's PL and TL, the core reviewers and subject
and subject matter experts within the StarlingX community. Consultation matter experts within the StarlingX community. Consultation with members of the
with members of the project's Test team are also advised. project's Test team are also advised.
Test plans can cover one or more StarlingX configurations, Test plans can cover one or more StarlingX configurations, define test cases
define test focused on the functional changes made, and sometimes include sanity tests or
cases focused on the functional changes made, and sometimes include full regression test runs by the test team, depending on the impact of the
sanity tests or full regression test runs by the test team, depending changes made.
on the impact of the changes made.
Test cases should be automated, and ideally run within Zuul jobs that Test cases should be automated, and ideally run within Zuul jobs that are
are triggered upon code check in. These tests can also be run locally. triggered upon code check in. These tests can also be run locally.
It is the responsibility of each project team to ensure that they It is the responsibility of each project team to ensure that they have the
have the proper test automation in Zuul jobs for their repos. It is proper test automation in Zuul jobs for their repos. It is the responsibility
the responsibility of every developer to submit new automated of every developer to submit new automated tests with their code changes.
tests with their code changes.
Some issues can be configuration specific and for instance only Some issues can be configuration specific and for instance only reproduce on
reproduce on standard configurations on bare metal, or on simplex standard configurations on bare metal, or on simplex configurations in a
configurations in a virtual environment. We don't expect every virtual environment. We don't expect every developer to have access to multiple
developer to have access to multiple hardware setups so collaboration hardware setups so collaboration with the test team is important. Collaboration
with the test team is important. Collaboration with the test with the test team may also be needed to help create new test cases in their
team may also be needed test suites.
to help create new test cases in their test suites.
Testing should also include unit tests or functional tests. Such Testing should also include unit tests or functional tests. Such tests should
tests should be added to the git repos as part of the code check in. be added to the git repos as part of the code check in.
Once all of the required tests are written, have been checked in Once all of the required tests are written, have been checked in and have been
and have been successfully successfully executed, the test phase is complete. Completion of developer
executed, the test phase is complete. Completion of testing is usually a requirement for acceptance of the code by the core
developer testing is usually a requirement for acceptance reviewers, so the implementation and test phases usually complete at the same
of the code by the core reviewers, so the implementation and test time.
phases usually complete at the same time.
.. rubric:: Getting help
The infrastructure used by StarlingX and other OpenInfra communities is
provided and maintained by `OpenDev <https://opendev.org>`_. Contributors
should take time to learn how the infrastructure works and work with the
OpenDev community to ensure that the resources that StarlingX is relying on are
maintained.
If you have issues or questions about `OpenDev <https://opendev.org>`_
infrastructure, you can search and post questions to the ``service-discuss``
mailing list at:
https://lists.opendev.org/archives/list/service-discuss@lists.opendev.org/latest
You will need to create an account and log in to post questions. No log-in is
required to view posts.
The OpenDev community is also available on IRC in the #opendev channel on the
OFTC network.
******************* *******************
Documentation phase Documentation phase
@ -592,23 +607,20 @@ Code changes to StarlingX that change the user interface, or
the project's APIs or the behavior of the system should be the project's APIs or the behavior of the system should be
documented. documented.
The process to submit a documentation change is described The process to submit a documentation change is described in the `Documentation
in the Contributor's Guide.
`Documentation Contributor's Guide.
<https://docs.starlingx.io/contributor/doc_contribute_guide.html>`_ <https://docs.starlingx.io/contributor/doc_contribute_guide.html>`_
Some changes may require an update to the project's release notes. Please Some changes may require an update to the project's release notes. Please
consult with your sub-project's PL and TL to see if release consult with your sub-project's PL and TL to see if release notes are needed,
notes are needed, and follow the and follow the `Release Note
`Release Note <https://docs.starlingx.io/contributor/release_note_contribute_guide.html>`_ to
<https://docs.starlingx.io/contributor/release_note_contribute_guide.html>`_ contribute your changes to the release notes.
to contribute your changes to the release notes.
The documentation changes needed for a code change should be The documentation changes needed for a code change should be included in the
included in the planning phase, working with project's docs team as planning phase, working with project's docs team as for help with the
for help with the documentation file format or for how to place documentation file format or for how to place your documentation changes into
your documentation changes into the projects formal documentation. the projects formal documentation.
The documentation phase is complete when all documents impacted The documentation phase is complete when all documents impacted by a change are
by a change are complete and have been merged by the docs project's complete and have been merged by the docs project's core reviewers.
core reviewers.