Contributing

Issues

Please report bugs or feature requests by creating GitHub issues.

In Code

If you want to contribute in code, pull requests are welcome!

Please do create a new issue before you dive into coding. It can well be that we already started working on the feature, or that there are upstream or downstream complexities involved which you might not be aware of.

SDK Code Generation

The biggest part of the code has been automatically generated by aas-core-codegen. It probably makes most sense to change the generator rather than add new functionality. However, this needs to be decided on a case-by-case basis.

Test Code Generation

The code of the unit tests has been automatically generated using the Python scripts in the testgen/ directory.

To re-generate the test code, first create a virtual environment at the root of the repository:

python -m venv venv

Activate the virtual environment (in Windows):

venv\Scripts\activate

or in Linux:

source venv/bin/activate

Then install the dependencies:

pip3 install -r testgen/requirements.txt

Now you can run the generation scripts:

python testgen/generate_all.py

Test Data

The test data is automatically generated by aas-core3.0-testgen, and copied to this repository on every change.

Build

To build the solution, run:

dotnet build src/

Pre-commit Checks

Before you can run pre-commit checks, you need to install the tools from src/ directory:

cd src
dotnet tool restore

Now you can execute the checks (from the repository root):

powershell src/Check.ps1

Pull Requests

Feature branches. We develop using the feature branches, see this section of the Git book.

If you are a member of the development team, create a feature branch directly within the repository.

Otherwise, if you are a non-member contributor, fork the repository and create the feature branch in your forked repository. See [this GitHub tuturial] for more guidance.

Branch Prefix. Please prefix the branch with your Github user name (e.g., mristin/Add-some-feature).

Continuous Integration. GitHub will run the continuous integration (CI) automatically through GitHub actions. The CI includes building the solution, running the test, inspecting the code etc.

If you installed all the tools (by dotnet tool restore, see above), you can run the CI checks locally:

powershell src/Check.ps1

Commit Messages

The commit messages follow the guidelines from https://chris.beams.io/posts/git-commit:

• Separate subject from body with a blank line,
• Limit the subject line to 50 characters,
• Capitalize the subject line,
• Do not end the subject line with a period,
• Use the imperative mood in the subject line,
• Wrap the body at 72 characters, and
• Use the body to explain what and why (instead of how).