Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

19 lines (10 loc) · 2.26 KB

Contributing and repository policy

This project welcomes contributions and suggestions. Please follow the guidelines below before opening new issues or pull requests.

Contributor license agreement

Any pull requests or commits require you to agree to The Modelica Association Contributor License Agreement (MA CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://github.com/modelica/ModelicaAssociationCLA.

When you submit a pull request, a bot will automatically determine whether you need to provide a MA CLA and decorate the pull request appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once.

Reporting issues

Please check the available labels and use them. The label descriptions clarify the kind of issues that can be reported. Every issue must be labeled with one collated-to category label (website, eFMI Standard, infrastructure) denoting the artifacts and/or functionality of the repository the issue is about. The issue also must be categorized if it is a general question, enhancement request or an actual bug (question, enhancement and bug labels). The documentation label is optional and used to denote that the issue is about the documentation of its collated-to category. The invalid label is used to denote issues that already exists, doesn't seem right or won't be worked on.

The eFMI Standard label is used to denote issues of publically released stable and candidate-draft eFMI Standard versions. If you report any standard issues, please denote the troublesome version of the standard first in the issue title, e.g., "eFMI 1.0.0 Alpha 4: The links in Chapter Foo-Bar are broken". And don't forget to add a categorization as explained in the previous paragraph (bug, ehancement or question label).

Branch protection and commits/pull requests

The main branch (main) of the repository is protected. All work must be done on separate branches, with pull requests to merge your new contributions into main. Respective pull requests must be reviewed by at least one code owner of the changed artifacts. Please cf. the CODEOWNERS file for who to add as reviewer to your pull request.