openstack/nova
Code Issues Proposed changes
nova/doc/source/contributor/index.rst
Takashi NATSUME 7dd7d9a5fa Use links to placement docs in nova docs 
Placement documents have been published since
I667387ec262680af899a628520c107fa0d4eec24.

So use links to placement documents
https://docs.openstack.org/placement/latest/
in nova documents.

Change-Id: I218a6d11fea934e8991e41b4b36203c6ba3e3dbf
2018-11-26 05:39:56 +00:00

3.5 KiB
Raw Blame History

Contributor Documentation

Contributing to nova gives you the power to help add features, fix bugs, enhance documentation, and increase testing. Contributions of any type are valuable, and part of what keeps the project going. Here are a list of resources to get your started.

Getting Started

  • /contributor/how-to-get-involved: Overview of engaging in the project
  • /contributor/development-environment: Get your computer setup to contribute

Nova Process

The nova community is a large community. We have lots of users, and they all have a lot of expectations around upgrade and backwards compatibility. For example, having a good stable API, with discoverable versions and capabilities is important for maintaining the strong ecosystem around nova.

Our process is always evolving, just as nova and the community around nova evolves over time. If there are things that seem strange, or you have ideas on how to improve things, please bring them forward on IRC or the openstack-dev mailing list, so we continue to improve how the nova community operates.

This section looks at the processes and why. The main aim behind all the process is to aid communication between all members of the nova community, while keeping users happy and keeping developers productive.

  • /contributor/project-scope: The focus is on features and bug fixes that make nova work better within this scope
  • /contributor/policies: General guidelines about what's supported
  • /contributor/process: The processes we follow around feature and bug submission, including how the release calendar works, and the freezes we go under
  • /contributor/blueprints: An overview of our tracking artifacts.

Reviewing

  • /contributor/releasenotes: When we need a release note for a contribution.
  • /contributor/code-review: Important cheat sheet for what's important when doing code review in Nova, especially some things that are hard to test for, but need human eyes.
  • /reference/i18n: What we require for i18n in patches
  • /contributor/documentation: Guidelines for handling documentation contributions

Testing

Because Python is a dynamic language, code that is not tested might not even be Python code. All new code needs to be validated somehow.

  • /contributor/testing: An overview of our test taxonomy and the kinds of testing we do and expect.
  • Testing Guides: There are also specific testing guides for features that are hard to test in our gate.
    • /contributor/testing/libvirt-numa
    • /contributor/testing/serial-console
    • /contributor/testing/zero-downtime-upgrade

The Nova API

Because we have many consumers of our API, we're extremely careful about changes done to the API, as the impact can be very wide.

  • /contributor/api: How the code is structured inside the API layer
  • /contributor/api-2: (needs update)
  • /contributor/microversions: How the API is (micro)versioned and what you need to do when adding an API exposed feature that needs a new microversion.
  • /contributor/api-ref-guideline: The guideline to write the API reference.

Nova Major Subsystems

Major subsystems in nova have different needs; some of those are documented here. If you are contributing to one of these please read the subsystem guide before diving in.

  • Placement API Developer Notes <contributor/index>
  • /user/conductor