add contributing guidelines and license

DitZii · Jun 4, 2021 · 62217a3 · 62217a3
1 parent 53e433b
commit 62217a3
Show file tree

Hide file tree

Showing 3 changed files with 692 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing to bunkerized-nginx
+
+First off all, thanks for being here and showing your support to the project !
+
+We accept many types of contributions whether they are technical or not. Every community feedback, work or help is, and will always be, appreciated.
+
+## Talk about the project
+
+The first thing you can do is to talk about the project. You can share it on social media, make a blog post about it or simply tell your friends/colleagues that's an awesome project.
+
+## Reporting bugs / ask for features
+
+The preferred way to report bugs and asking for features is using [issues](https://github.com/bunkerity/bunkerized-nginx/issues). Before opening a new one, please check if a related issue is already opened using the "filters" bar. When creating a new issue please select and fill the "Bug report" or "Feature request" template.
+
+## Code contribution
+
+The preferred way to contribute code is using [pull requests](https://github.com/bunkerity/bunkerized-nginx/pulls). Before creating a pull request, please check if your code is related to an opened issue. If that's not the case, you should first create an issue so we can discuss about it. This procedure is here to avoid wasting your time in case the PR will be rejected. For minor changes (e.g. : typo, quick fix, ...), opening an issue might be facultative. **Don't forget to edit the documentations when needed !**
+
+
+