-
Notifications
You must be signed in to change notification settings - Fork 215
Contributing
The eRPC project is placed on github. Contributing can be managed there via pull-request. Use the develop branch as the base branch for pull-requests. Before a pull-request is created, several tasks needs to be done: the code needs to be tested and properly formatted.
For easier pull request management it is recommended to select Allow edits from maintainers option when creating a pull request, see this GitHub Docs page.
eRPC is available with an unrestrictive BSD 3-clause license and this can't be changed in pull requests. Also newly added pull request files have to be licensed as BSD 3-clause license.
Two types of tests are used: pytest-based tests and acceptance tests.
These tests can be found in the erpc/erpcgen/test folder. Pytest can be executed via calling the pytest command from that directory. These tests have declared test cases in .yml files. Each test case has defined how an IDL file looks like and what is an expected output from that IDL file. Then, pytest generates the IDL file and calls the erpcgen application using that file. The output from the erpcgen application is controlled based on what was defined. More information can be found at pytest. Every time when new feature is added or bug is fixed, the test which covers that situation should be added.
The acceptance tests are placed in the erpc/test folder. These tests can be executed on Linux/Mac OS-based systems. When the use of makefiles shim code for tests is generated (make test or make all), then tests can be executed with python script erpc/test/run_unit_tests.py. These tests are testing the whole infrastructure of the eRPC application.
To format code, use the application developed by Google, named clang-format. This tool is part of the llvm project. Currently, the eRPC is using the clang-format version 10.0.0, available for download here.
The set of style settings used for clang-format is defined in the .clang-format file, placed in a root of the eRPC directory where Python script run_clang_format.py can be executed. This script executes an application named clang-format-10.0. You need to have the path of this application in the OS's environment path, or you need to change the script.