Contributing Guide

Thank you for investing your time in contributing to our project!

New contributor guide

To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub

• Set up Git

• GitHub flow

• Collaborating with pull requests

How to Contribute

Before Starting

• if you are fixing a bug, make sure that it still exists on the dev branch

• open up an issue to discuss the changes you want to make

• make sure you agree to our contributor license agreement

Accepting the Contributor License Agreement

When you create a new pull request on BeamNG-MATLAB-Simulink-integration, our CLA-bot will prompt you to sign the BeamNG Contributor License Agreement.

Submitting Your Contribution

1. Create a fork of the repository.

2. Using dev as a base branch create your own branch with a meaningful name and modify/add existing code following the PEP 8 style guide. Add tests where appropriate.

3. Push your branch to your fork and create a pull request from your branch to the dev branch. Posting the pull request will trigger a git action requesting you to accept the contribution license agreement.

Congratulations 🎉🎉 The BeamNG team thanks you ✨.

Once your pull request is merged, your contributions will be publicly visible on the Contributors page.