support financially
helping out
helping out
Section titled “helping out”so you wanna help? cool. here’s how.
ways to contribute
Section titled “ways to contribute”ways to contribute
Section titled “ways to contribute”improve docs
found something confusing? fix it or let us know.
write code
add features or fix bugs in the codebase.
help others
answer questions in the support server.
documentation
Section titled “documentation”amina has a lot of features. good docs make them usable.
what you can do:
- fix typos or unclear explanations
- add examples that helped you
- document undocumented features
- improve command descriptions
how to contribute:
- check the current docs and find what needs work
- open an issue on github or ask in discord
- once approved, make your changes
- submit a pull request
amina is open source and written in discord.js. check out the repo.
how to contribute:
- fork the repo on github
- clone your fork locally
- create a new branch for your feature/fix
- make changes with clear commit messages
- push to your fork
- open a pull request to main repo
what we need:
- bug fixes (check issues)
- performance improvements
- new features (discuss first in discord/issues)
- tests and documentation
what we don’t need:
- random rewrites without discussion
- features that don’t fit amina’s purpose
- code that breaks existing functionality
support server
Section titled “support server”if you know amina well, help others in the support server.
requirements:
- active for at least 2 weeks
- actually knows how amina works
- can troubleshoot problems independently
- patient with new users
how to become support staff:
- be active and helpful in the server
- show you know your stuff
- reach out to staff when ready
we’ll notice if you’re consistently helping others.
acknowledgements
Section titled “acknowledgements”thanks to everyone who helps make amina better.
special thanks:
- all supporters on ko-fi and patreon
- community members who answer questions
- contributors who submit code and docs
- river for the dashboard guide
- saiteja madha for source code reference
support development
Section titled “support development”support on ko-fi one-time or monthly support. helps keep amina running.
support on patreon monthly support with perks. early access to features.
ngl, running a bot costs money (hosting, api costs, etc). if amina helps your server, consider supporting development.