👍 First off, thank you for taking the time to contribute! 👍
The following is a set of guidelines for contributing to HELICS-ns3, HELICS and associated projects. These are suggested guidelines. Use your best judgment.
HELICS-ns3 package is distributed under the terms of the GPL-v2 LICENSE. This follows from the requirements of the GPL-v2 LICENSE of the NS3 LICENSE. Most individual files that are not copied and modified from the NS-3 code base have individual copyright and License under the terms of BSD-3 clause license. To be consistent with the rest of HELICS and the GMLC-TDC organization we would request any new files that do not require GPL-v2 licensing be released with a BSD-3-clause identification in the file itself. Discussions are ongoing which may allow licensing of a module under BSD-3-clause, at which point this repo would move wholly to a BSD License. Code modifications to existing files will be considered accepted under the license terms of the individual file. Modifications to GPL files may be followed by additional communications to verify acknowledgement of potential relicensure to BSD-3-clause in the future.
If you just have a question check out
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.