Skip to content

Commit

Permalink
Add contribution and support guidelines to the README. (#48)
Browse files Browse the repository at this point in the history
* Add contribution and support guidelines to the README.

* Add contribution and support guidelines to the webpage.
  • Loading branch information
jatkinson1000 committed May 9, 2024
1 parent e7dccf5 commit f31c074
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ A website for this workshop can be found at [https://cambridge-iccs.github.io/ml
- [Preparation and prerequisites](#preparation-and-prerequisites)
- [Installation and setup](#installation-and-setup)
- [License information](#license)
- [Contribution Guidelines and Support](#contribution-guidelines-and-support)


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

[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]

## Contribution Guidelines and Support

If you spot an issue with the materials please let us know by
[opening an issue](https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose)
here on GitHub clearly describing the problem.

If you are able to fix an issue that you spot, or an
[existing open issue](https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose)
please get in touch by commenting on the issue thread.

Contributions from the community are welcome.
To contribute back to the repository please first
[fork it](https://github.com/Cambridge-ICCS/ml-training-material/fork),
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.

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
[ICCS](https://github.com/Cambridge-ICCS).
7 changes: 7 additions & 0 deletions slides/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ <h2 id="contents">Contents</h2>
</ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contribution-guidelines-and-support">Contribution Guidelines and Support</a></li>
</ul>
</div>

Expand Down Expand Up @@ -290,6 +291,12 @@ <h2 id="license">License</h2>
<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>
<img src="https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png"></img></p>

<h2 id="contribution-guidelines-and-support">Contribution Guidelines and Support</h2>
<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>
<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>
<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>
<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>

</div>
</div>

Expand Down

0 comments on commit f31c074

Please sign in to comment.