aicoe-osc-demo welcomes contributions from developers and users. Follow the instructions in this section for a smooth interaction. The easiest way to contribute is to create issues that you encounter while running the demo. Someone from the team will review the issue and provide support with the demo.
The best way to contribute to the demo is to contribute code. Follow the instructions here to learn how to create a PR.
The pull request will be checked for 3 automatic tests:
Pre-commit ensures that the code is free of any style errors. Use the following commands after git add <file>
pip install pre-commit
pre-commit -run --all-files
Read and fix the changes suggested by pre-commit and then proceed to add the files and commit.
DCO is a way to verify the identity of the developer. To pass this test, you will have to sign your commit message.
`git commit -m "commit-message Signed-off-by name <email_id>"
Note: Creating a PR with one commit and one logical change makes reviewing the code much easier and increasing the chances of getting it merged faster. You can use the squash commit feature to collapse multiple commits into single commit.
This test ensures that the container image for this repository works, If you plan to make changes to the build pipeline components such as the docker or pip files, make sure that this test passes. In all other cases, it should automatically pass.
Another way of contributing to the project is to review an active PR. Follow the best practices for reviewing a PR.