auto-scaling-sig/CONTRIBUTING.rst
ricolin c22dde25d8 Use https links
Change-Id: I3041b9781e2c38baf4c9cc4c7092811daa14fcf0
2020-02-22 13:33:11 +08:00

4.5 KiB

orphan

Contributing to OpenStack's auto-scaling SIG

If you would like to participate in discussions or contribute in any way to the design and development of auto-scaling in OpenStack, please first see the following documentation to understand the SIG's mission, scope, and other supporting information:

https://docs.openstack.org/auto-scaling-sig

Many forms of contribution are valuable to the community, including but not limited to the following:

Everyone is warmly encouraged to get involved in whatever capacity you see fit.

Discussions

Discussions take place:

Join us in any of these places to provide your feedback and ideas so we can work on them together.

Use cases

The SIG serves to facilitate the discussion and documentation of auto-scaling use cases at all stages of development from a seed idea to a fully tested use case.

To call attention to a use case, please start the discussion in one of the established communication channels.

Alternatively, directly submit a patch to document the use case, following the format laid out in the template file in the use-cases/ directory of the auto-scaling-sig repository.

See Submitting a change for more information.

Design specs

Design specs are proposed implementations of auto-scaling functionality across projects. To author a new design spec, please follow the format laid out in the template file in the specs/ directory of the auto-scaling-sig repository.

See Submitting a change for more information.

Code

The auto-scaling-sig repository also holds any relevant cross-project code, tests, and documentation that do not naturally belong in a single project repository.

See Submitting a change for more information.

Submitting a change

To submit a change to this repository, please follow the steps in this page:

https://docs.openstack.org/infra/manual/developers.html

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

https://docs.openstack.org/infra/manual/developers.html#development-workflow

Pull requests submitted through GitHub will be ignored.

Report tasks/bugs in our StoryBoard

Auto-scaling SIG uses StoryBoard to manage all tasks. If you're planning any kind of tasks related to this SIG, you can create a story and link the task to other projects if needed. For example, the story "Build integration tests" has tasks that link to other projects. This way we can track all auto-scaling work in one place with references to the actual implementation. You might also create stories for bug reports regarding auto-scaling across OpenStack (or auto-scaling integration with other community tools).

Review on Gerrit

We would like to have more people to help on review patches so we can make sure the quality of it and confirm that whatever we put in is helpful.