1# The OpenBMC Tools Collection 2 3The goal of this repository is to collect the two-minute hacks you write to 4automate interactions with OpenBMC systems. 5 6It's highly likely the scripts don't meet your needs - they could be 7undocumented, dysfunctional or utterly broken. Please help us improve! 8 9## Repository Rules 10 11* _Always_ inspect what you will be executing 12* Some hacking on your part is to be expected 13 14## If you're still with us 15 16Then this repository aims to be the default destination for your otherwise 17un-homed scripts. As such we are setting the bar for submission pretty low, 18and we aim to make the process as easy as possible. 19 20## Sending patches 21 22Please use gerrit for all patches to this repository: 23 24* [Gerrit](https://gerrit.openbmc-project.xyz/) Repository 25 26Do note that you will need to be party to the OpenBMC CLA before your 27contributions can be accepted. See [Gerrit Setup and CLA][1] 28for more information. 29 30## What we will do once we have your patches 31 32So long as your patches look sane with a cursory glance you can expect them to 33be applied. We may push back in the event that similar tools already exist or 34there are egregious issues. 35 36## What you must have in your patches 37 38We don't ask for much, but you need to give us at least a 39[Signed-off-by](https://developercertificate.org/), use SPDX markers in your 40source files and put your work under an Apache 2.0 compatible license. 41 42## How you consume the repository 43 44There's no standard way to install the scripts housed here, and adding parts of 45the repository to your PATH might be a bit of a dice-roll. We may also move or 46remove scripts from time to time as part of housekeeping. It's probably best to 47copy things out if you need stability. 48 49[1]: https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server 50