Thank you for your interest in contributing to mind-android!
Your contributions help make this note editor for Android better for everyone.
- Report Bugs: Let us know if you find an issue.
- Suggest Features: Have an idea? Open a feature request!
- Improve Documentation: Notice a typo or unclear section? Help us improve it.
- Submit Code: Fix bugs, add features, or refactor code via pull requests.
- Fork this repository.
- Clone your fork and open it in Android Studio.
- Ensure you have:
- Android Studio (latest version recommended)
- Android SDK 24 or higher
- Java 8+ or Kotlin
- Build and run the app to verify your setup.
- Search existing issues first.
- Include:
- Device/emulator model and Android version
- Steps to reproduce the issue
- Expected and actual behavior
- Screenshots or logs if possible
- Clearly explain your idea and its purpose.
- Provide example use cases or user stories.
- For any changes you add, add your information to CONTRIBUTORS.md on a new line following this syntax:
[username](https:github.com/username) - What you've contributed - Write clear, descriptive commit messages.
- Follow code style conventions (Android Studio defaults/Kotlin style guide).
- Document all your additions or modifications to help the next person visiting the code and remember, straightforward to you isn't always straightforward to someone else.
- Test your code before submitting.
- Reference related issues in your pull request description.
- Submit your pull request to the
masterbranch.
- Use Java style conventions.
- Use Android Studio’s code formatting tools.
- Run formatter if available.
- If adding new features or fixing bugs, add or update tests when possible.
- Ensure all tests pass before submitting your pull request.
Please read and follow our Code of Conduct.
By contributing, you agree that your contributions will be licensed under the GPL v3.0 as described in the LICENSE file.