diff --git a/docs/content/how-to-contribute.md b/docs/content/how-to-contribute.md new file mode 100644 index 00000000..29efe8cc --- /dev/null +++ b/docs/content/how-to-contribute.md @@ -0,0 +1,14 @@ +Contribution is like any other GitHub project: + +- Fork +- Improve +- Add integration tests in `test/tests.bats` +- Build image and run tests using `make` +- Document your improvements +- Commit, push and make a pull-request + +#### Project architecture + + ├── config # User: personal configurations + ├── target # Developer: default server configurations + └── test # Developer: integration tests