|
|
@@ -37,6 +37,7 @@ GoLang | PostgreSQL | Git
|
|
|
- [Create a pull request](#create-a-pull-request)
|
|
|
- [Codebase](#codebase-)
|
|
|
- [The stack](#the-stack)
|
|
|
+- [Documentation](#documentation-)
|
|
|
- [Features](#features-)
|
|
|
- [Core team](#core-team-)
|
|
|
- [Sponsors](#sponsors-)
|
|
|
@@ -66,17 +67,17 @@ When in doubt, ask a [core team member](#core-team)! You can mention us in any i
|
|
|
|
|
|
## Contribution guideline 📜
|
|
|
|
|
|
-#### Create an issue
|
|
|
+### Create an issue
|
|
|
|
|
|
Nobody's perfect. Something doesn't work? Or could be done better? Let us know by creating an issue.
|
|
|
|
|
|
PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!
|
|
|
|
|
|
-#### Clean code with tests
|
|
|
+### Clean code with tests
|
|
|
|
|
|
Some existing code may be poorly written or untested, so we must have more scrutiny going forward. We test with **go test**, let us know if you have any questions about this!
|
|
|
|
|
|
-#### Create a pull request
|
|
|
+### Create a pull request
|
|
|
|
|
|
* Try to keep the pull requests small. A pull request should try its very best to address only a single concern.
|
|
|
* Make sure all tests pass and add additional tests for the code you submit.
|
|
|
@@ -90,6 +91,10 @@ Some existing code may be poorly written or untested, so we must have more scrut
|
|
|
|
|
|
View **Gitote** tech stack [here](docs/STACK.md)
|
|
|
|
|
|
+## Documentation 📑
|
|
|
+
|
|
|
+View **Gitote** documentations [here](docs)
|
|
|
+
|
|
|
## Features 🔮
|
|
|
|
|
|
- Activity timeline
|
Yoginth