From f078387d8d63f59713b3509edc5505a458de2f76 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Mon, 14 Oct 2019 10:21:33 +0200 Subject: [PATCH] Update DEVELOPMENT.md --- DEVELOPMENT.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index cf00e6a..cd70b96 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,10 +1,17 @@ -Here's some general stuff to keep in mind, and some work that needs to be done +Here's some general stuff to keep in mind, and some work that needs to be done: -* Mastodon.py tries to work for python2 as well as python3, so avoid things like annotations, - use requests over urllib, et cetera. - -* Current TODOs: - * Testing - test 2.3 stuff and verify it works: TODO: media updating - * 2.4 support: - * Document and add tests for webpush - \ No newline at end of file +* If you'd like to contribute, here's some suggestions: + * Features are currently up to date and mostly tested, but there are some areas where tests could be + better. Check the codecov page and try to add tests those areas. + * Nodeinfo is currently just documented by reference to the spec. It could be documented better. + * Nodeinfo currently just retrieves the 2.0 spec version. It should likely attempt to retrieve other + versions as well, trying to get the most recent one available. + * There's some code duplication in places that could be lessened. + * Other implementations of the Mastodon API as well as Mastodon forks exist - it may be good to try to support these: + * Figure out what they do different and file issues / document it + * Where code can be written to support alternate implementations or different features, write code to do this + * Write tests specific to these features +* Mastodon.py still somewhat tries to work for python2 as well as python3, so avoid things like annotations, + use requests over urllib, et cetera. However, python2 is not officially supported and not tested for anymore, + and once python2 reaches end of life (January 1st, 2020), this is over with. +