Skip to content

Commit

Permalink
add contributing page (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
zerosnacks authored May 3, 2024
1 parent 0bf76af commit 75f4551
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Alloy

:balloon: Thanks for your help improving the project! We are so happy to have
🎈 Thanks for your help improving the project! We are so happy to have
you!

There are opportunities to contribute to Alloy at any level. It doesn't
Expand Down Expand Up @@ -121,7 +121,7 @@ docker run -p 3000:3000 -v `pwd`:/book peaceiris/mdbook serve

To perform an update of generated output inspect and run `./scripts/update.sh`.

To add a new section (file) to the book, add it to [`SUMMARY.md`](./src/SUMMARY.md).
To add a new section (file) to the book, add it to `./src/SUMMARY.md`.

### Discuss and update

Expand Down
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,4 @@
# Appendix

- [Glossary](./appendix/glossary.md)
- [Help us improve Alloy](./appendix/contributing.md)
1 change: 1 addition & 0 deletions src/appendix/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{#include ../../CONTRIBUTING.md}}

0 comments on commit 75f4551

Please sign in to comment.