👍 First off, thank you for taking the time to contribute! 👍
The following is a set of guidelines for contributing to HELICS and associated projects. These are suggested guidelines. Use your best judgment.
HELICS is distributed under the terms of the BSD-3 clause license. All new contributions must be made under this LICENSE in accordance with the GitHub terms of service, which uses inbound=outbound policy. By submitting a pull request you are acknowledging that you have the right to license your code under these terms.
If you just have a question check out
and there are a few questions answered on the github WIKI page for HELICS.
This section guides you through submitting a bug report for HELICS. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
When you are creating a bug report, please include as many details as possible. Frequently, helpful information includes operating system, version, compiler used, API, interface, and some details about the function or operation being performed.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
This section guides you through submitting a feature request, or enhancement for HELICS, including completely new features and minor improvements to existing functionality.
Please include as much detail as possible including the steps that you imagine you would take if the feature you're requesting existed, and the rational and reasoning of why this feature would be a good idea for a co-simulation framework.
A pull request including a bug fix or feature will always be welcome.
There are a number of separate repositories included in the GMLC-TDC organization. Please feel free to explore those repositories for examples and additional tools, and to contribute.
- check the issue list for any similar issues
- take a look at the RoadMap or projects to see if the feature is already planned, and if so feel free to add some feedback if it could be improved.
Unsure where to begin contributing to HELICS? You can start by looking for help wanted beginner issues:
Help with documentation and test cases is always welcome. Take a look at the code coverage reports for some ideas on places that need more testing
Typically you would want to submit a pull request against the develop branch. That branch gets merged into master periodically but the develop branch is the active development branch where all the code is tested and merged before making a release. There is a Pull request template that will guide you through the needed information. The pull requests are run through several automated checks as part of CI builds and for the most part must pass these tests before merging. The Codacy check is evaluated but not required as the checks are sometimes a bit aggressive.
Code formatting is controlled via clang-format, a somewhat higher level style guide can be found here. The code is not fully conformant to this yet but we are slowly working on it.