Skip to content

Commit 1b4981c

Browse files
committed
Added contributing and TOC sections
1 parent 255b63e commit 1b4981c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ Syropod High-level Controller (SHC) is a versatile controller capable of generat
1111
<a href="https://research.csiro.au/robotics/our-work/research-areas/legged-robots/"><img alt="Gizmo Wizmo Zero" align="center" width="500" src="https://i.imgur.com/HCrmRDS.gif"/></a>
1212
</p>
1313

14+
## Table of Contents
15+
16+
* [Getting Started](#Getting-Started)
17+
* [Features](#Features)
18+
* [Config Files](#Config-Files)
19+
* [Nodes](#Nodes)
20+
* [Changelog](#Changelog)
21+
* [Authors](#Authors)
22+
* [License](#License)
23+
* [Contributing](#Contributing)
24+
* [Issues](#Issues)
25+
1426
## Getting Started
1527

1628
If you haven't looked at the tutorials for using OpenSHC, see [OpenSHC Tutorials](https://github.com/csiro-robotics/shc_tutorials).
@@ -257,6 +269,10 @@ See [CHANGELOG.md](CHANGELOG.md) for release details.
257269

258270
This project is licensed under the CSIRO Open Source Software Licence Agreement (variation of the BSD / MIT License) - see the [LICENSE](LICENSE) file for details.
259271

272+
## Contributing
273+
274+
Thank you for being interested in contributing. We encourage the community to create new features and to fix bugs. If it is a new feature, please create a new issue via the [Issue Tracker](https://github.com/csiro-robotics/syropod_highlevel_controller/issues) and describe the intended feature so that we can discuss the implementation. Else, search for the existing issue and comment on your proposed work. Please fork the repo, work on your changes and then send a pull request.
275+
260276
## Issues
261277

262278
Please report bugs using [Issue Tracker](https://github.com/csiro-robotics/syropod_highlevel_controller/issues) or contact us via email [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)