Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.83 KB

CONTRIBUTING.rst

File metadata and controls

88 lines (62 loc) · 2.83 KB
Raw

Contributing

Setting up a development environment in an OpenStack VM using cloud-init

The following cloud-config script can be passed as a --user-data argument to nova boot. This will result in a fully operational DLRN environment to hack on.

#cloud-config
disable_root: 0

users:
  - default

package_upgrade: true

packages:
  - vim
  - git
  - policycoreutils-python-utils

runcmd:
  - yum -y install epel-release
  - yum -y install puppet
  - git clone https://github.com/rdo-infra/puppet-dlrn /root/puppet-dlrn
  - cd /root/puppet-dlrn
  - puppet module build
  - puppet module install pkg/jpena-dlrn-*.tar.gz
  - cp /root/puppet-dlrn/examples/common.yaml /var/lib/hiera
  - puppet apply --debug /root/puppet-dlrn/examples/site.pp 2>&1 | tee /root/puppet.log

final_message: "DLRN installed, after $UPTIME seconds."

Setting up a development environment manually

Follow the instructions from the Setup section of README.rst to manually setup a development environment.

Submitting pull requests

Pull requests submitted through GitHub will be ignored. They should be sent to SoftwareFactory's Gerrit instead, using git-review. The usual workflow is:

$ sudo yum install git-review  (you can also use pip install if needed)
$ git clone https://github.com/softwarefactory-project/DLRN
<edit your files here>
$ git add <your edited files>
$ git commit
$ git review
New patches should:
  • Explain the changes in the commit message.
  • Include unit tests for the new code to prove that it works correctly and to prevent regressions.
  • For changes visible to end-users (e.g. new API) we need to update the necessary RST files under the doc/ folder.
  • Execute all CI checks without errors by executing the command tox.

Once submitted, your change request will show up here:

https://softwarefactory-project.io/r/#/q/project:DLRN+status:open

At least the approval from one core reviewer is needed to merge a change request.

Generating the documentation

Please note that the RDO Packaging Documentation also contains instructions for DLRN.

The documentation is generated with Sphinx. To generate the documentation, go to the documentation directory and run the make file:

$ cd DLRN/doc/source
$ make html

The output will be in DLRN/doc/build/html