Ta4j Wiki

Documentation, examples and further information of the ta4j project

View the Wiki On GitHub

This project is maintained by ta4j Organization

How to Contribute

What is a contribution?

In our terms a contribution is already to share a good analysed bug report Found a bug? If you want to go deeper and you want to contribute test cases, e.g. for a quality contribution (identify a bug) or to help us to keep the lib clean and stable. Or you have even a nice idea, which you would like to contribute as code? You are always welcome. We suggest you before you contribute a bigger work to get prior permission, since we want to verify first if the contribution will bring the lib forward. We will give quickly a feedback if we will accept the contribution.

How to contribute?

In the most cases (e.g. bug fixes and little enhancements) you can create a pull request to the develop branch. For bigger improvements please open an issue to discuss your plans.

Take a look at the branching model to get an overview. You can fork and clone the repository and set up the develop branch as follows:

// fork repositroy on Git UI from https://github.com/ta4j/ta4j.git to https://github.com/yourAccount/ta4j.git
git clone https://github.com/yourAccount/ta4j.git
cd ta4j
git remote add develop https://github.com/yourAccount/ta4j.git
git checkout develop

If necessary and coordinated, you can also create a new feature branch for bigger enhancements:

git checkout -b feature/name-of-your-feature-branch
git push --set-upstream origin feature/*
mvn test // run tests
git add myNewFiles.java CHANGELOG.md
git commit
git push

The last step would be to do a pull request from your branch to the develop branch of the ta4j repository. If you want to do a pull-request, the best way is to do is via Git UI:

Coding rules and conventions

General

(in progress..)
First things first: Feel free to write awesome code! Do not hesitate to open an issue or a pull request just because you fear making a mistake. Others can review your code, give you tips and can correct you.

Hints

Indicators

If you want to add a new indicator to this repository, please open an issue first to discuss your plans.