Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

36 lines (20 loc) · 2.87 KB
Raw

How to contribute to ta4j

Thanks for considering contributing to ta4j! Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Reporting bugs and opening issues

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue (if an error is being thrown a non-minified stack trace helps)
  • Motivation for or Use Case (explain why this is a bug for you)
  • Versions (ta4j version, Java version, etc.)
  • Reproduce the Error (provide a SSCCE or a unambiguous set of steps)
  • Related Issues (has a similar issue been reported before?)
  • Suggest a Fix (if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit))

Submitting a patch

Each pull request is highly appreciated! Here are some tips to get it merged:

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it. Pull requests of features without tests will not be accepted.

  4. All contributions must be MIT licensed and all files must have a copy of the boilerplate licence comment (can be copied from an existing file). Files should be formatted according to the implicit guidelines used until now.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Finally, push the commits to your fork and submit a pull request.

Looking for something to work on? Take a look at the roadmap or our open issues.