From ca0d7318f419ef386f8ea84db44fcf2fd891fd1c Mon Sep 17 00:00:00 2001 From: Teiva Harsanyi Date: Sun, 1 Oct 2023 13:27:11 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a77918d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing to 100 Go Mistakes + +First of all, thank you for taking the time to contribute! 🎉 + +We aim to create a collaborative space that could become the canonical place to find common mistakes to avoid in Go. + +If you want to participate, please look at the open issues. The 100 Go Mistakes repository is a documentation project, so all the content that can be enriched is in the +[/docs](https://github.com/teivah/100-go-mistakes/tree/master/docs) folder. The main file is [index.md](https://github.com/teivah/100-go-mistakes/blob/master/docs/index.md), +the one containing the main content of [100go.co](https://100go.co/). + +If you submit a PR, please do not care about the HTML generation (the website uses MkDocs), I'll take care of it. Said differently, most PRs should +only contain modifications to .md files.