Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 2.56 KB
Raw

Contributing to ShowJava

  1. Fork the repository. (niranjan94/show-java)
  2. Clone the repository locally by using the command: git clone git@github.com:username/show-java

Connect your local to the original ‘upstream’ repository by adding it as a remote. Pull in changes from ‘upstream’ often so that you stay up to date so that when you submit your pull request, merge conflicts will be less likely. See more detailed instructions here.

  1. Create a branch for your edits/bugfixes/feature additions
  2. Do your magic
  3. Test whatever you made in Android versions 4.1.x , 4.4.x, 5.x, 6.x, 7.x etc (You get the idea 😉 )
  4. Once you're confident in your code, send a pull request to the development branch of the upstream repository with a proper descriptions explaining what you did and why. Be clear and consise.
  5. Wait for one of the project maintainers to review your pull request.
  6. We may merge it into the development branch if it's good.

Also have a look at the GitHub Flow, to understand better how all this works.

Reporting a Bug (over here)

  1. Check existing issues for your issue. Duplicating an issue is slower for both parties so search through open and closed issues to see if what you’re running into has been addressed already.
  2. Be clear about what your problem is: what was the expected outcome, what happened instead? Detail how someone else can recreate the problem.
  3. Include system details like Android version, total RAM, etc.
  4. If possible, include the link to the app that you were trying to decompile
  5. Paste stacktrace (if possible) in your issue or in a Gist. If pasting them in the issue, wrap it in three backticks: ``` so that it renders nicely.
  6. Submit it and wait for one of the project maintainers to review it. (Please be patient)

Requesting a Feature/Enhancement (over here)

  1. Check existing issues for your issue. Duplicating an issue is slower for both parties so search through open and closed issues to see if what you’re running into has been addressed already.
  2. Give a clear and a consise description about the feature/enhancement that you'd love to see in ShowJava
  3. Submit it and wait for one of the project maintainers to review it. (Please be patient)