Skip to main content

Contributing

aMule is a community-driven project, kept alive entirely by volunteers. You do not need to be a programmer to help: reporting bugs, translating, improving the documentation, testing new builds, and answering other users' questions are all valuable contributions.

Where the Project Lives​

All of aMule's development and communication happens out in the open on GitHub. Everything — the source code, this website, the documentation, bug reports, feature requests, and discussions — is managed in two repositories:

If you want to follow what is going on, ask a question, or get involved, these two repositories are the place to be.

Ways to Contribute​

Bug Reports​

Found something that does not work? Reporting it is one of the most useful things you can do, and it does not require any programming knowledge. Open an issue on the GitHub issue tracker. See the Bug Reports page for what to include and how to generate a useful crash backtrace.

Code​

If you write code, submit a pull request on GitHub. Follow the coding style guide and make sure the project still builds (see Compilation) — every pull request is also built and tested automatically on Windows, macOS, and Linux.

Translations​

aMule is translated by the community using GNU gettext. See the Translations guide to update an existing language, add a new one, or translate the man pages.

Documentation​

Improve or expand this documentation website. Its source lives in the website repository. See the Documentation guide for the repository structure, writing guidelines, and the PR workflow.

Help Other Users​

You do not need to write a single line of code to give back to the project. Helping other people use aMule is a contribution in its own right.

Head over to GitHub Discussions — the project's community forum — to answer questions, share your configuration tips, and help newcomers get started. Every answered question makes aMule easier to use for the next person.