Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.75 KB

Contributing

We welcome any contributions! If you wish to contribute:

  • Fork the repository
  • Clone your fork to your development machine
  • Run ./gradlew clean build to confirm you are starting from a working Setup
  • Please report any issues with this build step in the GitHub project's issues
  • Create a branch for your work
  • Setup your development environment (see below)
  • Make changes
  • Run ./gradlew clean build to test your changes locally
  • Push your branch to your fork
  • Make a Pull Request against the master branch

Development Environment Setup

//TODO romeara setup standard handling/process for applying formatting & templates Currently, Eclipse is the supported IDE for development. It is recommended to create an isolated workspace for blackducksoftware projects. You should also import the standard formatting and save settings

Custom Setup

To run tests, the property com.blackduck.method.analyzer.test.project.dir must be set to the file path of the method-analyzer-test-project directory in the run/debug settings of TestNG. Executions of the tests from the command line via Gradle are configured with this value automatically.

General Standards

In general, pull requests should:

  • Be small and focused on a single improvement/bug
  • Include tests for changed behavior/new features
  • Match the formatting of the existing code
  • Have documentation for added methods/classes and appropriate in-line comments
  • Have additions to the CHANGE_LOG.md file recording changed behavior

Conduct

We expect both outside contributors and blackducksoftware members to treat each with respect and promote constructive discussion. Please report any inappropriate interactions (with a link to the offending pull request, etc, if possible) to [email protected]