Skip to content
This repository has been archived by the owner on Nov 10, 2017. It is now read-only.

Latest commit

 

History

History
98 lines (69 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

98 lines (69 loc) · 3.43 KB
Raw

Contributing to the Android for Maven Eclipse

The Android for Maven Eclipse project follows the Github Workflow and contributions can be made by sending a pull requests or raising issues.

##Pull requests should...

###...focus on quality

Code should be readable, maintainable, clean, follow SOLID principals, not repeat code elsewhere (DRY) and conform to the style guide.

###...be fully testable

All new functionality or bugs should be developed using Test Driven Development ensuring tests are written first, you regularly refactor, etc..

To run the tests in Maven execute the following from within the cloned project folder:

$ mvn -Dtycho.showEclipseLog=true verify

You can also run the tests inside Eclipse using the PDE JUnit launcher ([com.googlecode.eclipse.m2e.android.test] test) in the test module. There is also a launcher to run an instance of Eclipse with the latest m2e-android code in your local workspace ([com.googlecode.eclipse.m2e.android] run).

Note: You may find tests can stall because the ADT is waiting for user interraction from dialogs. To avoid this execute the following command:

$ echo 'adtUsed=true'$'\n'pingId=844 > ~/.android/ddms.cfg

###...have a clear intention

Commits should be clear, traceable and grouped according to their intention as outlined in this git style guide. Commit messages should be clear and follow the standard git format.

##Bug reports should be...

###...Clear

Bug reports should have:

  • Precise, descriptive summaries.
  • Informative, concise descriptions.
  • A neutral tone, avoiding complaints or conjecture.

###...Reproducible

Bug reports should contain:

  • The simplest steps to reproduce the issue, or...
  • A failing test fixture for the bug.

###...Specific

Only publish one bug per report accompanied by:

  • A detailed description of the issue focusing on the facts.
  • Expected and actual results.
  • Versions of software, platform and operating system used.
  • Crash data, including stack traces, log files, screenshots and other relevant information.

If you are sendling log files, please ensure that debug mode is enabled so we get full log files. To do so please follow these instructions:

  1. Open you eclipse.ini file in a text editor.
  2. At the bottom of the file add the following line:
-DM2E_ANDROID_DEBUG=true

You should now have debug logging for m2e-android enabled when you restart Eclipse.

###...Unique

Please search for duplicates before reporting a bug and ensure summaries include relevant keywords to make it easier for others to find duplicates.