openstack/requirements
Code Issues Proposed changes

clean up readme

Browse Source 
Fix the tag badges.

Update the rule about minimum versions.

Remove the section about upgrading dependencies, since that happens in
each repository now.

Change-Id: I9b6ade5e389c72baa92ac35700e9edeafc3d79f3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-04-12 17:35:39 -04:00
parent 42c9f5f4a5
commit d7e9c86bd5
1 changed files with 7 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.rst
View File

@ -1,16 +1,10 @@
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/requirements.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
============================================
Global Requirements for OpenStack Projects
============================================
.. image:: https://governance.openstack.org/tc/badges/requirements.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
Why Global Requirements?
========================
@ -232,12 +226,11 @@ General Review Criteria
*is* stable, or to contribute to the upstream community to help
stabilize it.
- Libraries should contain a sensible known working minimum version
- Library specifications should not contain a minimum version
Bare library names are bad. If it's unknown what a working minimum
is, look at the output of pip freeze at the end of a successful
DevStack/tempest run and use that version. At least that's known to
be working now.
Individual projects may want to start with different "lower bound"
versions of dependencies, so we do not track those explicitly in the
``global-requirements.txt`` file.
- Commit message should refer to consuming projects(s)
@ -337,23 +330,6 @@ For new Requirements
.. _Licensing requirements: https://governance.openstack.org/tc/reference/licensing.html
For Upgrading Requirements Versions
-----------------------------------
- Why is it impossible to use the current version definition?
Everyone likes everyone else to use the latest version of their
code. However, deployers really don't like to be constantly updating
things. Unless it's actually **impossible** to use the minimum
version specified in ``global-requirements.txt``, it should not be
changed.
Leave that decision to deployers and distros.
- Changes to update the minimum version of a library developed by the
OpenStack community can be approved by one reviewer, as long as the
constraints are correct and the tests pass.
.. _finding-distro-status:
Finding Distro Status