662a463fad
The mention of documentation in the readme talks about both Zuul and Zuul Client, so link to the general docs index where both of them are listed. Change-Id: I69b9cc1866fe69d37d5c564bdb17006ee911aa53
58 lines
1.6 KiB
ReStructuredText
58 lines
1.6 KiB
ReStructuredText
Zuul-client
|
|
===========
|
|
|
|
Zuul-client is a CLI tool that can be used to interact with Zuul, the project
|
|
gating system.
|
|
|
|
The latest documentation for Zuul and Zuul Client can be found at:
|
|
https://zuul-ci.org/docs/
|
|
|
|
Getting Help
|
|
------------
|
|
|
|
There are two Zuul-related mailing lists:
|
|
|
|
`zuul-announce <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-announce>`_
|
|
A low-traffic announcement-only list to which every Zuul operator or
|
|
power-user should subscribe.
|
|
|
|
`zuul-discuss <http://lists.zuul-ci.org/cgi-bin/mailman/listinfo/zuul-discuss>`_
|
|
General discussion about Zuul, including questions about how to use
|
|
it, and future development.
|
|
|
|
You will also find Zuul developers in the `#zuul` channel on Freenode
|
|
IRC.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
To browse the latest code, see: https://opendev.org/zuul/zuul-client
|
|
To clone the latest code, use `git clone https://opendev.org/zuul/zuul-client`
|
|
|
|
Bugs are handled at: https://storyboard.openstack.org/#!/project/zuul/zuul
|
|
|
|
Suspected security vulnerabilities are most appreciated if first
|
|
reported privately following any of the supported mechanisms
|
|
described at https://zuul-ci.org/docs/zuul/user/vulnerabilities.html
|
|
|
|
Code reviews are handled by gerrit at https://review.opendev.org
|
|
|
|
After creating a Gerrit account, use `git review` to submit patches.
|
|
Example::
|
|
|
|
# Do your commits
|
|
$ git review
|
|
# Enter your username if prompted
|
|
|
|
Join `#zuul` on Freenode to discuss development or usage.
|
|
|
|
License
|
|
-------
|
|
|
|
Zuul-client is free software, and licensed under the Apache License, version 2.0.
|
|
|
|
Python Version Support
|
|
----------------------
|
|
|
|
Zuul-client requires Python 3. It does not support Python 2.
|