diff options
Diffstat (limited to 'docs/14_contributing.rst')
| -rw-r--r-- | docs/14_contributing.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/14_contributing.rst b/docs/14_contributing.rst new file mode 100644 index 0000000..7f743b0 --- /dev/null +++ b/docs/14_contributing.rst | |||
| @@ -0,0 +1,33 @@ | |||
| 1 | Contributing | ||
| 2 | ============ | ||
| 3 | |||
| 4 | How to contribute | ||
| 5 | ----------------- | ||
| 6 | |||
| 7 | Mastodon.py is incomplete a lot of the time because Mastodon has a very rich API with many functions, not all of which are implemented here. | ||
| 8 | Even when it is complete for a given Mastodon API version, there are forks and other Mastodon-API-compatible software that implement their own methods which Mastodon.py could in principle support. | ||
| 9 | And even when all of that work is done, it will inevitably have bugs, or places where the library could be made easier to use (which, really, are also bugs), missing tests that could catch bugs quicker, tooling to make updating everything faster, et cetera. | ||
| 10 | |||
| 11 | You can help get more of this done, and you should! This can take many forms: If you notice somtehing is missing, broken or confusing: | ||
| 12 | |||
| 13 | * You could file an issue on github, either with or without suggestions for how to fix the issue: https://github.com/halcy/Mastodon.py/issues | ||
| 14 | * You could, after filing an issue, do a PR that fixes that issue | ||
| 15 | * You could even just vaguely complain in my (https://icosahedron.website/@halcy) general direction on Mastodon | ||
| 16 | |||
| 17 | All of these help immensely, even if it's just "hey, I don't really get why X isn't working". We can't make the library better if we don't know what the actual issues people | ||
| 18 | have are, so while I'm not going to implement every suggestion and do have some ideas of what does and does not make a good library, your feedback is, in fact, extremely valuable | ||
| 19 | and welcome. | ||
| 20 | |||
| 21 | If you're looking for some "starter issues" to address: Currently, we don't have support for much of any of the new 4.0.0 API endpoints implemented. Pick one and have a go, | ||
| 22 | especially from the admin API. Tests are somewhat annoying to set up, as they need to run against a live mastodon instance - great if you can write them, but feel free to | ||
| 23 | skip out on them, too, or just write them "in the dry" without actually running them and leaving that for someone else. | ||
| 24 | |||
| 25 | Tests | ||
| 26 | ----- | ||
| 27 | Mastodon.py has an extensive suite of tests. The purpose of these is twofold: | ||
| 28 | |||
| 29 | * Make sure nothing is broken and that there aren't any regressions | ||
| 30 | * Where the official docs are unclear, verify assumptions we make about the Mastodon API and document the results | ||
| 31 | |||
| 32 | The tests use pytest and pytest-vcr so that they can be ran even without a mastodon server, but new tests require | ||
| 33 | setting up a mastodon dev server. Further documentation can be found in the "tests" directory in the repository. \ No newline at end of file | ||