diff options
| author | Lorenz Diener <[email protected]> | 2019-10-14 10:21:33 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-10-14 10:21:33 +0200 |
| commit | f078387d8d63f59713b3509edc5505a458de2f76 (patch) | |
| tree | ed82ee9956af74da8aaeda4fa8162254455d19ce | |
| parent | a5758f3f6ee1abe030913aaffc4ec1bc548acdde (diff) | |
| download | mastodon.py-f078387d8d63f59713b3509edc5505a458de2f76.tar.gz | |
Update DEVELOPMENT.md
| -rw-r--r-- | DEVELOPMENT.md | 25 |
1 files 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 @@ | |||
| 1 | Here's some general stuff to keep in mind, and some work that needs to be done | 1 | Here's some general stuff to keep in mind, and some work that needs to be done: |
| 2 | 2 | ||
| 3 | * Mastodon.py tries to work for python2 as well as python3, so avoid things like annotations, | 3 | * If you'd like to contribute, here's some suggestions: |
| 4 | use requests over urllib, et cetera. | 4 | * Features are currently up to date and mostly tested, but there are some areas where tests could be |
| 5 | 5 | better. Check the codecov page and try to add tests those areas. | |
| 6 | * Current TODOs: | 6 | * Nodeinfo is currently just documented by reference to the spec. It could be documented better. |
| 7 | * Testing - test 2.3 stuff and verify it works: TODO: media updating | 7 | * Nodeinfo currently just retrieves the 2.0 spec version. It should likely attempt to retrieve other |
| 8 | * 2.4 support: | 8 | versions as well, trying to get the most recent one available. |
| 9 | * Document and add tests for webpush | 9 | * There's some code duplication in places that could be lessened. |
| 10 | \ No newline at end of file | 10 | * Other implementations of the Mastodon API as well as Mastodon forks exist - it may be good to try to support these: |
| 11 | * Figure out what they do different and file issues / document it | ||
| 12 | * Where code can be written to support alternate implementations or different features, write code to do this | ||
| 13 | * Write tests specific to these features | ||
| 14 | * Mastodon.py still somewhat tries to work for python2 as well as python3, so avoid things like annotations, | ||
| 15 | use requests over urllib, et cetera. However, python2 is not officially supported and not tested for anymore, | ||
| 16 | and once python2 reaches end of life (January 1st, 2020), this is over with. | ||
| 17 | |||