aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2022-11-17 13:55:22 +0100
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2022-11-19 19:23:03 +0100
commita1f888d6ac877e9d55404376d0442ab5470461c9 (patch)
tree54b3f2de2b14f76a6f05cc4fb002076af586d0be
parent043abf015275bd0b2cc71391921268267cebf30d (diff)
readme
-rw-r--r--README.org16
1 files changed, 5 insertions, 11 deletions
diff --git a/README.org b/README.org
index 5f1eea3..e5930a4 100644
--- a/README.org
+++ b/README.org
@@ -297,19 +297,11 @@ Optional dependencies:
- =mpv= and =mpv.el= for viewing videos and gifs
- =lingva.el= for translating toots
-** Nota Bene regarding work on this library
-
-I resurrected this library a few years ago, and have added stacks of features and fixes over time. I do it in my spare time and tend to implement features I want to use. I am not a professional programmer. I never aimed to implement all Mastodon features, nor to provide a professional service to others. I have implemented some things I don't use, such as filters, but mostly I can only fix bugs with things that I regularly rely on.
-
-Please keep this in mind when requesting features that are not implemented. Feel free to open an issue and start a discussion, but don't try to order things from me.
-
-The better option is to look at the code and seeing how you can implement the feature yourself. A lot of the functionality you'll need is already implemented. I'm happy to give pointers on what you might use.
-
** Contributing
PRs, issues, feature requests, and general feedback are very welcome!
-*** Bugs
+*** Bug reports
1. =mastodon.el= has bugs, as well as lots of room for improvement.
2. I receive very little feedback, so if I don't run into the bug it often doesn't get fixed.
@@ -321,13 +313,15 @@ PRs, issues, feature requests, and general feedback are very welcome!
1. Create an [[https://codeberg.org/martianh/mastodon.el/issues][issue]] detailing the feature you'd like to add.
2. Fork the repository and create a branch off of =develop=.
-3. Create a pull request referencing the issue created in step 1.
+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.
*** Fixes
1. In an [[https://codeberg.org/martianh/mastodon.el/issues][issue]], let me know that you're working to fix it.
2. Fork the repository and create a branch off of =develop=.
-3. Create a pull request referencing the issue from step 1.
+3. Run the tests and ensure that your code doesn't break any of them.
+4. Create a pull request referencing the issue from step 1.
** Supporting mastodon.el