6fb715b47c
This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38556 Change-Id: I4bfe9db179fdf2285e847544cdb98c597ec388a6
specs-cookiecutter
Cookiecutter template for an OpenStack specs repo projects. See https://github.com/audreyr/cookiecutter.
- Free software: Apache license
- pbr: Set up to use Python Build Reasonableness
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily building sphunx docs
- Sphinx docs: Documentation ready for generation and publication
Usage
Generate a Python package project:
cookiecutter https://git.openstack.org/openstack-dev/specs-cookiecutter.gitOpenStack projects require a working git repo for pbr to work, so you need to init a repo and commit to it before doing anything else:
cd $repo_name
git init
git add .
git commit -aThen:
- Add the project to the OpenStack Infrastructure