Skip to content

Commit

Permalink
Added section about contributing to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteP1 committed Aug 27, 2024
1 parent 9d81135 commit cfa7900
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,34 @@ Currently, the [Iris Lecture Notes](https://iris-project.org/tutorial-material.h

In its current state, this tutorial does not go over the underlying model of Iris. For readers who wish to learn about the underlying model of Iris, we refer to the [Iris from the ground up](https://people.mpi-sws.org/~dreyer/papers/iris-ground-up/paper.pdf) paper. Advanced readers may read this paper prior to going through the tutorial. However, it is generally recommended to study it afterwards, given its technical nature.

## Generating the exercises
If you want to contribute to the tutorial, note that the files in `exercises/` are generated from the corresponding files in `theories/`. Run `make exercises` to re-generate those files. This requires `gawk` to be installed (which should be available on Linux, and on macOS can be installed via `brew install gawk`).
## Contributing

The hope is that the maintenance and extension of this tutorial becomes a collaborative community effort. We warmly welcome all contributions—whether it's correcting a typo, improving clarity, or extending the tutorial with new chapters.

If you have suggestions for future topics or improvements for existing ones, please add them to [TODO.md](TODO.md).

### How to Contribute
To contribute, we recommend following these steps:

1. Fork the repository.
2. Create a new branch on the forked repository.
3. Make your changes in the branch.
4. Commit and push your changes.
5. Open a pull request to the main repository

For more detailed instructions, see [first-contributions](
https://github.com/firstcontributions/first-contributions).

### CoqdocJS
This tutorial uses [CoqdocJS](https://github.com/coq-community/coqdocjs), so please make sure to format your changes accordingly. To see what your changes will look like in the documentation, run
```
git submodule update --init
make html
```
Then open `html/toc.html` in a browser, and navigate to the chapter(s) containing your changes.

### Generating the Exercises
Note that the files in `exercises/` are generated from the corresponding files in `theories/`. As such, if you wish to make changes to a chapter, please make those changes to the `theories`-version of the chapter. Afterwards, the `exercises`-version can be re-generated by running `make exercises`. This requires `gawk` to be installed (which should be available on Linux, and on macOS can be installed via `brew install gawk`).

The syntax for the solution files is as follows:

Expand All @@ -163,3 +189,10 @@ and the more powerful
is replaced by

exercise template here.

### Contact
If you have specific requests or questions about the tutorial, please contact:

**Amin Timany**\
Aarhus University\
<timany@cs.au.dk>

0 comments on commit cfa7900

Please sign in to comment.