aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.org b/README.org
index dfbb95c..05f80fa 100644
--- a/README.org
+++ b/README.org
@@ -358,7 +358,7 @@ PRs, issues, feature requests, and general feedback are very welcome!
(it probably does).
4. Enable debug on error (=toggle-debug-on-error=), make the bug happen again,
and copy the backtrace that appears.
-5. Open an issue here and explain what is going on.
+5. Open an issue here and explain what is going on. Provide your emacs version and what kind of server your account is on.
*** Fixes and features
@@ -367,10 +367,17 @@ PRs, issues, feature requests, and general feedback are very welcome!
3. Run the tests and ensure that your code doesn't break any of them.
4. Create a pull request referencing the issue created in step 1.
+*** coding style
+
+- This library uses an unconvential double dash (=--=) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed.
+- Use =aggressive-indent-mode= or similar to keep your code indented.
+- Single spaces end sentences in docstrings.
+- There's no need for a blank line after the first docstring line (one is added automatically when documentation is displayed).
+
** Supporting mastodon.el
If you'd like to support continued development of =mastodon.el=, I accept
-donations via paypal at martianhiatus [ at ] riseup [ dot ] net. If you would
+donations via paypal: https://paypal.me/martianh. If you would
prefer a different payment method, write to me at that address and I can
provide IBAN or other details.