Skip to content

Latest commit

 

History

History
18 lines (16 loc) · 2.34 KB

contributing.md

File metadata and controls

18 lines (16 loc) · 2.34 KB
Raw

Contributing

  • Check the Planned features/work in progress [1]
  • Please report any problem on the Gitlab issue tracker - include the following information:
    • Expected results, steps to reproduce the problem, observed results
    • Relevant technical information (configuration, logs, versions...)
    • If reporting a security issue, please check the This issue is confidential checkbox
  • Please send patches by Merge request or attached to your bug reports
    • Patches must pass CI checks, include relevant documentation, and be split in a meaningful way
    • Tests/static analysis can be run locally using make tests. See Makefile for more details.
    • You can test a full deployment from scratch, against a local test VM using make test_idempotence. See RELEASE PROCEDURE in the Makefile for more information.
    • You can test your changes in your own playbook, by pointing at your local copy of the collection in requirements.yml using a git+file:/// URI and the appropriate branch name, and updating the collection (using ansible-galaxy or xsrv upgrade).
    • If your changes introduce new variables, tests should be conducted with different possible values for these variables. Both deploying a new host, and applying the role to an already deployed host should work.
    • Any substantial changes/additions/removals must be added to the changelog. Changes that require actions from the user must be added to Upgrade procedure in the changelog section for the affected version.
    • Changes introducing new functionality should include relevant tests/sanity checks (e.g. new configuration variables)
    • You can find an example role which can be used as a template to develop new roles here. See this commit for an example.
  • Please contribute to upstream projects and report issues on relevant bug trackers