Create CONTRIBUTING.md

This commit is contained in:
Teiva Harsanyi 2023-10-01 13:27:11 +02:00 committed by GitHub
parent 75c24d5af6
commit ca0d7318f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

12
CONTRIBUTING.md Normal file
View file

@ -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.