summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.org
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-02-09 15:58:50 +0200
committerThanos Apollo <[email protected]>2024-02-09 19:21:27 +0200
commit3c98f92491a0ac81a95af49038665099423661ab (patch)
tree0b22fd3cf910d808d77dc5685caf4391c15cb63e /CONTRIBUTING.org
parent2bc2c9df057b88ef3c8de324d97d8f45c3705973 (diff)
Add CONTRIBUTING.org
Diffstat (limited to 'CONTRIBUTING.org')
-rw-r--r--CONTRIBUTING.org33
1 files changed, 33 insertions, 0 deletions
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
new file mode 100644
index 0000000..4cf194f
--- /dev/null
+++ b/CONTRIBUTING.org
@@ -0,0 +1,33 @@
+#+title: Contributing | Gnosis
+#+author: Thanos Apollo
+
+
+* Sources
++ [[https://git.thanosapollo.org/gnosis][Upstream]]
+
+* How To Contribute
+Before starting to work on any big feature, that is not mentioned on
+the [[Task List][Task List]], I recommend you to send me an email first.
+
+** How to submit a PR?
+Feel free to send me a patch, here's how to create one:
+
+#+begin_src bash
+$ git clone https://git.thanosapollo.com/<repo>.git && cd <repo>
+$ emacs something
+$ git add something
+$ git commit -m "Fix something"
+$ git format-patch HEAD^1
+0001-Fix-something.patch
+#+end_src
+
+/You can find my email on the git log/
+
+
+* Tasks
+** TODO Add Dashboard
++ Create a dashboard to view all notes created, user can edit &
+ suspend notes. Use tabulated-list-mode, preferably.
+
+** TODO Algorithm: changes for ef increase/decrease factors
++ After 3 successful in a row reviews increase ef increase factor by 5% & vice versa