125813880SAndrew Jeffery# The OpenBMC Tools Collection 225813880SAndrew Jeffery 325813880SAndrew JefferyThe goal of this repository is to collect the two-minute hacks you write to 425813880SAndrew Jefferyautomate interactions with OpenBMC systems. 525813880SAndrew Jeffery 625813880SAndrew JefferyIt's highly likely the scripts don't meet your needs - they could be 7f92f9433SAndrew Jefferyundocumented, dysfunctional or utterly broken. Please help us improve! 825813880SAndrew Jeffery 925813880SAndrew Jeffery## Repository Rules 1025813880SAndrew Jeffery 11*e310dd91SPatrick Williams- _Always_ inspect what you will be executing 12*e310dd91SPatrick Williams- Some hacking on your part is to be expected 1325813880SAndrew Jeffery 1425813880SAndrew Jeffery## If you're still with us 1525813880SAndrew Jeffery 1625813880SAndrew JefferyThen this repository aims to be the default destination for your otherwise 17*e310dd91SPatrick Williamsun-homed scripts. As such we are setting the bar for submission pretty low, and 18*e310dd91SPatrick Williamswe aim to make the process as easy as possible. 19fc615edfSAndrew Jeffery 2025813880SAndrew Jeffery## Sending patches 2125813880SAndrew Jeffery 2226e29305SAndrew GeisslerPlease use gerrit for all patches to this repository: 2325813880SAndrew Jeffery 24*e310dd91SPatrick Williams- [Gerrit](https://gerrit.openbmc-project.xyz/) Repository 25f92f9433SAndrew Jeffery 2626e29305SAndrew GeisslerDo note that you will need to be party to the OpenBMC CLA before your 27*e310dd91SPatrick Williamscontributions can be accepted. See [Gerrit Setup and CLA][1] for more 28*e310dd91SPatrick Williamsinformation. 2925813880SAndrew Jeffery 3025813880SAndrew Jeffery## What we will do once we have your patches 3125813880SAndrew Jeffery 32f92f9433SAndrew JefferySo long as your patches look sane with a cursory glance you can expect them to 33f92f9433SAndrew Jefferybe applied. We may push back in the event that similar tools already exist or 34f92f9433SAndrew Jefferythere are egregious issues. 3525813880SAndrew Jeffery 3625813880SAndrew Jeffery## What you must have in your patches 3725813880SAndrew Jeffery 3825813880SAndrew JefferyWe don't ask for much, but you need to give us at least a 399723789dSAndrew Jeffery[Signed-off-by](https://developercertificate.org/), use SPDX markers in your 409723789dSAndrew Jefferysource files and put your work under an Apache 2.0 compatible license. 4125813880SAndrew Jeffery 4225813880SAndrew Jeffery## How you consume the repository 4325813880SAndrew Jeffery 449723789dSAndrew JefferyThere's no standard way to install the scripts housed here, and adding parts of 459723789dSAndrew Jefferythe repository to your PATH might be a bit of a dice-roll. We may also move or 469723789dSAndrew Jefferyremove scripts from time to time as part of housekeeping. It's probably best to 479723789dSAndrew Jefferycopy things out if you need stability. 4826e29305SAndrew Geissler 49*e310dd91SPatrick Williams[1]: 50*e310dd91SPatrick Williams https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server 51