Skip to content

Commit f31c074

Browse files
Add contribution and support guidelines to the README. (#48)
* Add contribution and support guidelines to the README. * Add contribution and support guidelines to the webpage.
1 parent e7dccf5 commit f31c074

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ A website for this workshop can be found at [https://cambridge-iccs.github.io/ml
2424
- [Preparation and prerequisites](#preparation-and-prerequisites)
2525
- [Installation and setup](#installation-and-setup)
2626
- [License information](#license)
27+
- [Contribution Guidelines and Support](#contribution-guidelines-and-support)
2728

2829

2930
## Learning Objectives
@@ -252,3 +253,24 @@ The teaching materials are licensed under a
252253
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg
253254

254255
[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]
256+
257+
## Contribution Guidelines and Support
258+
259+
If you spot an issue with the materials please let us know by
260+
[opening an issue](https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose)
261+
here on GitHub clearly describing the problem.
262+
263+
If you are able to fix an issue that you spot, or an
264+
[existing open issue](https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose)
265+
please get in touch by commenting on the issue thread.
266+
267+
Contributions from the community are welcome.
268+
To contribute back to the repository please first
269+
[fork it](https://github.com/Cambridge-ICCS/ml-training-material/fork),
270+
make the neccessary changes to fix the problem, and then open a pull request back to
271+
this repository clerly describing the changes you have made.
272+
We will then preform a review and merge once ready.
273+
274+
If you would like support using these materials, adapting them to your needs, or
275+
delivering them please get in touch either via GitHub or via
276+
[ICCS](https://github.com/Cambridge-ICCS).

slides/index.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ <h2 id="contents">Contents</h2>
9191
</ul>
9292
<li><a href="#prerequisites">Prerequisites</a></li>
9393
<li><a href="#license">License</a></li>
94+
<li><a href="#contribution-guidelines-and-support">Contribution Guidelines and Support</a></li>
9495
</ul>
9596
</div>
9697

@@ -290,6 +291,12 @@ <h2 id="license">License</h2>
290291
<p>The teaching materials are licensed under <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>.<br>
291292
<img src="https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png"></img></p>
292293

294+
<h2 id="contribution-guidelines-and-support">Contribution Guidelines and Support</h2>
295+
<p>If you spot an issue with the materials please let us know by <a href="https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose" target=blank>opening an issue</a> on GitHub clearly describing the problem.</p>
296+
<p>If you are able to fix an issue that you spot, or an <a href="https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose" target=blank>existing open issue</a> please get in touch by commenting on the issue thread.</p>
297+
<p>Contributions from the community are welcome. To contribute back to the repository please first <a href="https://github.com/Cambridge-ICCS/ml-training-material/fork" target=blank>fork it</a>, make the neccessary changes to fix the problem, and then open a pull request back to this repository clerly describing the changes you have made. We will then preform a review and merge once ready.</p>
298+
<p>If you would like support using these materials, adapting them to your needs, or delivering them please get in touch either via GitHub or via <a href="https://github.com/Cambridge-ICCS" target=blank>ICCS</a>.</p>
299+
293300
</div>
294301
</div>
295302

0 commit comments

Comments
 (0)