Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 5.47 KB

HowToContribute.md

File metadata and controls

81 lines (53 loc) · 5.47 KB
Raw

How to contribute

Thank you for your interest in improving scenario_simulator_v2. This contributor guidelines will help you get started.

If you have any questions, please feel free to contact the maintainers.

Before you get started

To avoid duplicate work, please review current issues and pull requests.

Contribution workflow

Please take the following steps:

  1. Fork this repository.
  2. Clone down the repository to your local machine.
  3. Create a new branch from the master. See Branch naming rules below.
  4. Commit your changes to the branch and push the commit to your GitHub repository that was forked in Step 1.
  5. Open a Pull Request (PR). Our CI workflows will automatically test your changes. See Continuous integration below.
  6. The maintainers will review your PR. Once the PR is approved, the code will be merged into the master branch. See Code review below.

Branch naming rules

Feature development

Each new feature development should be worked on in its own branch.

Please add the feature/ prefix to your branch name. For example:

feature/(name of the feature you are developing)

Bugfix

Please add the fix/ prefix to your branch name. For example:

fix/(name of bug what you are fixing)

Release

Only maintainers create the release/ branch.

release/prepare_(version_tag)

The release branches are used only to update the release notes. An example is here.

Continuous integration

Your changes proposed in your pull request will be tested automatically by the following checks:

Checks Description
ScenarioTest Build all packages and run integration tests.
BuildTest Build each package independently, run linters, and run unit tests.
Docker Build a docker image.
Documentation Build the documentation sites.
SpellCheck Run a spell checker and add warnings to the PR.

If you contribute to the documentation, your changes should pass the checks below:

Checks Description
Documentation Build the documentation sites.
SpellCheck Run a spell checker and add warnings to the PR.

Code review

Any changes to the code or documentation are subject to code review. Maintainers will review your pull request.

As a good practice, reply to the reviewer's comment with a link to your changes (e.g., Fixed in a0b1c2d). To keep the commit hashes consistent, please DO NOT force-push the commit to your pull request during the code review. If you want to force-push the commit during the review, please contact the maintainers for approval in advance.

If more than one maintainer approves your pull request and all checks are passed, your pull request will be merged into the master branch. Your contribution will be recorded in the release note.