Ways to Contribute

Contribute your knowledge

Help others by participating in discussions on GitHub or by joining our mailing list fluxnova@lists.finos.org (email help@finos.org to add you to the list).

File bugs or feature requests

Found a bug in the code or have a feature that you would like to see in the future? Search our open issues if we have it on the radar already or create a new issue otherwise.

Please try to create high quality issues:

• Give enough context so that a person who doesn't know your project can understand your request
• Be concise, only add what's needed to understand the core of the request
• If you raise a bug report, describe the steps to reproduce the problem
• Specify your environment (e.g. Fluxnova version, Fluxnova modules you use, ...)
• Provide code. For a bug report, create a test that reproduces the problem. For feature requests, create mockup code that shows how the feature might look

Contribute code

You can contribute code that fixes bugs and/or implements features. Here is how it works:

• Select an issue that you would like to work on. Have a look at our Project Board or the issues lists for the individual projects, e.g. Fluxnova-BPM-Platform Issues if you need inspiration. Be aware that some of the issues need good knowledge of the surrounding code.
• Create a fork of the project to contribute from. Create a feature branch in your fork to hold your changes.
• Check your code changes against our contribution checklist (For large changes, open a draft PR before you have finished your implementation to get feedback.)
• Create a pull request.

Browse our issues

We manage issues for the multiple Fluxnova projects through our Project Board. You can find the full list of FINOS hosted Fluxnova projects here.

We use labels to mark and group our issues for easier browsing. We define the following label prefixes: ** labels arent in Fluxnova. Needs To Be Reviewed **

• bot: labels that control a github app, workflow, ...
• ci: labels that control the CI for a pull request
• group: Arbitrary labels that we can define to group tickets. If you create this, please add a DRI to the description to make sure someone has ownership, e.g. to decide if we still need the label
• potential: Issues that we are potentially releasing with the given version. This is not a guarantee and does not express high confidence.
• hacktoberfest: labels for hacktoberfest contributions. This prefix cannot be changed. It is a rule of Hacktoberfest to name it like that.
• scope: The technical scope in which the ticket makes changes.
• type: Issue type. Every issue should have exactly one of these labels. They are automatically added when you create a new issue from a template.
• version: Issues that will be released (with high confidence) with the given version.

More...

More details are available in these areas:

• Building Fluxnova BPM Platform Locally
• Building with GitHub Actions on FINOS
• Running Fluxnova BPM Platform
• Create a pull request
• Contribution checklist
• Contributor License Agreement (CLA)
• Commit message conventions
• Review process

View full details