Develop¶

Namespace¶

All of the source code is and must be made available under the OpenCOR namespace (e.g., [OpenCOR]/src/mainwindow.cpp and [OpenCOR]/src/mainwindow.h). There are only two exceptions to this rule: [OpenCOR]/src/main.cpp and [OpenCOR]/src/windows/main.cpp (i.e. OpenCOR’s two main .cpp files).

Issues¶

All changes to the source code must be referenced in the list of issues using labels to:

• Request a for or an to a future version of OpenCOR.

• Report a or a issue with the current official version of OpenCOR.

• Specify a that needs to be carried out for the next official version of OpenCOR.

• Specify the binding () associated with a , , or issue.

• Specify the platform(s) (, , and/or ) associated with a , , or issue.

Continuous integration¶

Whenever something is pushed to the Git repository, OpenCOR gets automatically built and tested on Windows, Linux and macOS, through GitHub Actions.

Anyone wanting to contribute to OpenCOR should first fork the Git repository. Work for issue #XXX should then be done in a branch called issueXXX. The work done, a pull request should be created. This will trigger OpenCOR to be built and tested. Assuming everything goes well, the project manager will decide whether to merge the pull request.

Additional information¶

More specific information can be found in the following pages:

• Coding style

• Plugins

  • Sample

  • Sample tools

  • Sample view

  • Sample window

• Internationalisation

• Tests