Skip to content

Latest commit

 

History

History
53 lines (25 loc) · 2.2 KB

File metadata and controls

53 lines (25 loc) · 2.2 KB

Contributing to DynamiaTools

Contributions to DynamiaTools are welcome and encouraged, but please have a look through the guidelines in this document before raising an issue, or writing code for the project.

Using issues

The issue tracker is the preferred channel for reporting bugs, requesting new features and submitting pull requests.

Please do not use issues for support requests. For help using DynamiaTools, please take a look at the dynamia-tools tag on Stack Overflow.

Reporting bugs

Well structured, detailed bug reports are hugely valuable for the project.

Guidlines for reporting bugs:

  • Check the issue search to see if it has already been reported
  • Isolate the problem to a simple test case

Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.

Local development

Run mvn clean install to build the project, clone the example project and run tests as you make changes.

Pull requests

Clear, concise pull requests are excellent at continuing the project's community driven growth. But please review these guidelines and the guidelines below before starting work on the project.

Guidelines:

  • Please create an issue first and/or talk with a team member:
    • For bugs, we can discuss the fixing approach
    • For enhancements, we can discuss if it is within the project scope and avoid duplicate effort
  • Please make changes to the files in /sources/src/main.
  • Code is written in IntelliJ community edition if you use another IDE use similar code conventions
  • If adding new functionality, please also update the relevant .md file
  • Please make your commits in logical sections with clear commit messages

Joining the project

  • Active committers and contributors are invited to introduce yourself and request commit access to this project. Please send an email to tools@dynamiasoluciones.com or file an issue.