Skip to content
Permalink
Browse files

Add contributing and contact docs.

Add docs on contributing and how to reach us on IRC.
  • Loading branch information
sadsfae committed Feb 12, 2020
1 parent a56fdad commit 0f72be74f8efa82490bb0b6f1f7c4debff9890e0
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
@@ -28,6 +28,8 @@
* [Log to File](#log-to-file)
* [iDRAC and Data Format](#idrac-and-data-format)
* [Dell Foreman and PXE Interface](#dell-foreman-and-pxe-interface)
* [Contributing](#contributing)
* [Contact](#contact)

# Badfish
Badfish is a Redfish-based API tool for managing bare-metal systems via the [Redfish API](https://www.dmtf.org/standards/redfish)
@@ -193,3 +195,20 @@ Your usage may vary, this is what our configuration looks like via ```config/idr
| Dell r720xd | NIC.Integrated.1-3-1 |
| Dell r730xd | NIC.Integrated.1-3-1 |
| Dell r740xd | NIC.Integrated.1-3-1 |

## Contributing
We love pull requests and welcome contributions from everyone! Please use the `development` branch to send pull requests. Here are the general steps you'd want to follow.

1) Fork the Badfish Github repository
2) Clone the forked repository
3) Push your changes to your forked clone
4) Open a pull request against our `development` branch.

* Here is some useful documentation
- [Creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
- [Keeping a cloned fork up to date](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)

## Contact

* You can find us on IRC in `#quads` on `irc.freenode.net` if you have questions or need help. [Click here](https://webchat.freenode.net/?channels=quads) to join in your browser.

0 comments on commit 0f72be7

Please sign in to comment.
You can’t perform that action at this time.