Contributing to Audile

Thank you for your interest in improving Audile. As a free, open source, and noncommercial project, we rely on community contributions. Whether you are reporting a bug, proposing a feature, translating, or submitting code, your help is greatly appreciated.

General Guidelines

• Use English for all communication, including issues, discussions, pull requests, and code comments.
• Use GitHub Discussions for general questions.
• Use GitHub Issues for bug reports and feature requests.
• Do not use generative AI to write issue descriptions or discussion posts. Using AI for grammar correction or translation is acceptable.

Reporting Bugs

• Ensure you are on the latest app version. The bug might have already been fixed.
• Search the issue tracker for open or closed issues matching your problem to avoid duplicates.
• Open a separate issue for each bug. Do not combine multiple bugs or feature requests into one report.
• Provide clear steps to reproduce the issue. Include relevant logs, screenshots, and system details.

Requesting Features

• Ensure you are on the latest app version. The feature might have already been implemented.
• Search the issue tracker to check if your idea has already been proposed. If it exists, upvote the original post rather than adding comments like "I also want this".
• Submit only one feature request per issue.
• Explain the specific problem you are facing and how your proposed feature solves it.
• Be detailed. If your request involves UI changes, describe the layout and expected user interaction.

Translating

Translations are managed via Weblate. You can register a new account or log in with your GitHub profile. Feel free to submit new translations, correct errors, or suggest better phrasing for existing strings. Please do not submit pull requests for translations directly to the repository.

Submitting a Pull Request

Before starting development, please add a comment to an existing issue or open a new one to describe your planned changes. This initiates a discussion about your approach and informs others that you are working on it.

Code Contribution Rules

• Keep changes focused. Avoid mixing unrelated changes in a single pull request.
• Do not upgrade dependencies or build tools without a clear and justified reason.
• Modify only the English string resources. All other translations belong on Weblate.
• Do not include any proprietary libraries or assets.
• Ensure the project builds successfully before committing. Refer to the detailed build instructions.
• Test your code thoroughly and include automated tests where applicable.

AI Code Policy

Please refrain from using generative AI to write entire new features or make substantial architectural changes on your behalf. Contributions that heavily rely on AI generated code typically lack a fundamental understanding of the project details and result in poor quality, so they will not be accepted.

You may only use generative AI if you meet all of the following conditions:

• You are fully aware of the existing project structure.
• You completely understand every line of the generated code.
• You ensure the generated code perfectly matches the project architecture and style.
• You have thoroughly reviewed and tested the result.

Pull requests that violate this policy will be closed.

Donating

Audile is completely free. It comes without any ads or other forms of commercial monetization. To support ongoing development consider making a donation.

Licensing

By contributing to this repository, you agree that your contributions will be licensed under the same license as the Audile project itself.