evennia/docs/source/How-To-Get-And-Give-Help.md

72 lines
4.4 KiB
Markdown
Raw Normal View History

# How To Get And Give Help
### How to *get* Help
2020-10-11 19:31:05 +02:00
If you cannot find what you are looking for in the [online documentation](./index), here's what to do:
2021-06-13 22:02:18 +02:00
2020-10-11 19:31:05 +02:00
- If you think the documentation is not clear enough and are short on time, fill in our quick little
[online form][form] and let us know - no login required. Maybe the docs need to be improved or a new
tutorial added! Note that while this form is useful as a suggestion box we cannot answer questions
or reply to you. Use the discussion group or chat (linked below) if you want feedback.
2021-06-13 22:02:18 +02:00
- If you have trouble with a missing feature or a problem you think is a bug, go to the
2020-10-11 19:31:05 +02:00
[issue tracker][issues] and search to see if has been reported/suggested already. If you can't find an
existing entry create a new one.
- If you need help, want to start a discussion or get some input on something you are working on,
make a post to the [discussions group][group] This is technically a 'mailing list', but you don't
need to use e-mail; you can post and read all messages just as easily from your browser via the
online interface.
- If you want more direct discussions with developers and other users, consider dropping into our
IRC chat channel [#evennia][chat] on the *Freenode* network. Please note however that you have to be
patient if you don't get any response immediately; we are all in very different time zones and many
have busy personal lives. So you might have to hang around for a while - you'll get noticed
eventually!
### How to *give* Help
2020-10-11 19:31:05 +02:00
Evennia is a completely non-funded project. It relies on the time donated by its users and
developers in order to progress.
2021-06-13 22:02:18 +02:00
The first and easiest way you as a user can help us out is by taking part in
[community discussions][group] and by giving feedback on what is good or bad. Report bugs you find and features
2020-10-11 19:31:05 +02:00
you lack to our [issue tracker][issues]. Just the simple act of letting developers know you are out
there using their program is worth a lot. Generally mentioning and reviewing Evennia elsewhere is
also a nice way to spread the word.
If you'd like to help develop Evennia more hands-on, here are some ways to get going:
2020-10-11 19:31:05 +02:00
- Look through our [online documentation wiki](./index) and see if you
can help improve or expand the documentation (even small things like fixing typos!). You don't need
any particular permissions to edit the wiki.
- Send a message to our [discussion group][group] and/or our [IRC chat][chat] asking about what
needs doing, along with what your interests and skills are.
- Take a look at our [issue tracker][issues] and see if there's something you feel like taking on.
[here are bugs][issues-master] that need fixes. At any given time there may also be some
[bounties][issues-bounties] open - these are issues members of the community has put up money to see
fixed (if you want to put up a bounty yourself you can do so via our page on
[bountysource][bountysource]).
- Check out the [Contributing](./Contributing) page on how to practically contribute with code using
github.
2020-10-11 19:31:05 +02:00
... And finally, if you want to help motivate and support development you can also drop some coins
2021-06-13 22:02:18 +02:00
in the developer's cup. You can [make a donation via PayPal][paypal] or, even better,
[become an Evennia patron on Patreon][patreon]! This is a great way to tip your hat and show that you
2020-10-11 19:31:05 +02:00
appreciate the work done with the server! Finally, if you want to encourage the community to resolve
a particular
2021-06-13 22:02:18 +02:00
[form]: https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0
[group]: http://groups.google.com/group/evennia/
[issues]: https://github.com/evennia/evennia/issues
2021-06-13 22:02:18 +02:00
[issues-master]: https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-branch
[chat]: http://webchat.freenode.net/?channels=evennia
2021-06-13 22:02:18 +02:00
[paypal]: https://www.paypal.com/se/cgi-bin/webscr?cmd=_flow&SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9
2020-10-11 19:31:05 +02:00
b2
2021-06-13 22:02:18 +02:00
[donate-img]: http://images-focus-opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&container=focus&gadget=a&rewriteMime=image/*
[patreon]: https://www.patreon.com/griatch
[patreon-img]: http://www.evennia.com/_/rsrc/1424724909023/home/evennia_patreon_100x100.png
[issues-bounties]: https://github.com/evennia/evennia/labels/bounty
[bountysource]: https://www.bountysource.com/teams/evennia