Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 3.26 KB
Raw

Amaze was created with a vision to provide all the basic and advanced features a file manager in Android is supposed to have, with a friendly material design. As with any other open source project, contributions are the key to achieve this goal of ours.

Contributions are always welcome!

To start contributing, we assume you know how to use git and write and debug Android apps - don't expect we can teach you ;)

Please keep in mind the points below before considering contributing to Amaze:

  • Make sure to write your name and Email-ID in format Name<email> in the license declaration above every file you make change to. You won't be able to claim the license for changes made by you unless you do that. If there's no license header in any file, please include one from GNU GPL v3 webpage.
  • Please follow Android/JAVA code style for writing any code, but do not use the Hungarian notation proposed - discussion here. Also, follow Android Material Design guidelines in case you make changes to any UI element.
  • To file a bug report, it is recommended to include the steps to reproduce it; and even better, it helps us a lot if you can capture the error messages in logcat too It is also recommended to enroll to our beta program from Play Store to test and verify any fix for the same.

We work with pull requests, so, for improvements, new features or bugfixes, please submit your changes as pull requests. We will then:

  1. start review of your code for cleanliness and robustness
  2. test them to see if they work as you said
  3. merge the pull request

To speed up the review process, please:

  • write your code cleanly. We also have our day time work, we are not able to correct the mistakes in your code.
  • before opening PR, run ./gradlew spotlessCheck and ./gradlew spotlessApply in your local to check / fix any formatting issues.
  • describe clearly what your pull request does
  • if you're fixing a particular bug in the issue list, please explicitly say "Fixes #" in your description
  • once you've opened PR, look out for CI builds, if there is any code smell / bug - CI will complain, please work on it to keep the code clean.
  • while not required (because automated tests can't test everything), it's recommended you to include Robolectric/Espresso tests in your pull request

Finally:

  • we have our day time work, so except security vulnerabilities, your submission may be left cold for a couple of days before being picked up by us
  • it's good to start a new branch to start your work. Not just for a shiny branch name, but also for your own good
  • we can be harsh when reviewing your work but because we want to have good code in our codebase. Be patient and carefully read our comments
  • we can be wrong. Again, be patient when discuss with us - we accept reason, but we never accept hate speech

If we feel your PR is a significant help to us, we'll award you a bounty with any of your preferred mode of payment.
Please provide the details for the same once asked. Ready to roll? Start forking ;)