Skip to content

Contributing to OpenCDA-MARL

Thank you for considering contributing to OpenCDA-MARL! We welcome contributions from the community to make our project better. Before you get started, please take a moment to read the following guidelines.

Please do not directly create a branch from the original repo. Please fork the OpenCDA-MARL repository to your local github repo instead

Forking the repository helps keep the main project tidy. It allows you to make changes in your forked repository without cluttering the original repository. Please make changes in your local repo and when the codes are ready to merge with the main branch, please create a pull request to the official OpenCDA-MARL repo. Project maintainers will review your changes, suggest modifications if needed, and discuss any concerns.

Fork the Repository

  • Navigate to the OpenCDA-MARL repository on GitHub.
  • Click the "Fork" button in the top-right corner of the page. This action will create a personal fork of the OpenCDA-MARL repository under your GitHub account.

Clone the repository and create your own branch

  • Running the command git clone https://github.com/your-username/OpenCDA-MARL
  • Add the official OpenCDA-MARL repository as a remote to stay updated: git remote add upstream https://github.com/radar-lab/OpenCDA-MARL
  • Create your own branch git checkout -b feature/short_summary_of_feature
  • Make your changes, commit them, and push to your fork
git add .
git commit -m "Description of changes"
git push origin feature/short_summary_of_feature

Submit Pull Request

  • Go to the Pull Requests tab of the official OpenCDA-MARL repository.
  • Click on the "New Pull Request" button and click compare across forks
  • Set the base repository to "lgcyaxi/OpenCDA-MARL". Set the head repository to your own forked OpenCDA-MARL repo e.g., "your-name/OpenCDA-MARL" and set the compare to the branch you created e.g., "feature/short_summary_of_feature".
  • Provide a title and description for your pull request, explaining the changes you made.
  • Click "Create Pull Request."
  • Please use this template for your pull requests.

Project maintainers will review your changes, suggest modifications if needed, and discuss any concerns. Make necessary changes by pushing them to the same branch. The pull request will automatically update. Once your changes are approved, they will be merged into the main project.

Contribution Guidelines

We welcome your contributions.

  • Please report bugs and improvements by submitting issues.
  • Submit your contributions using pull requests as described above.

Thank you for contributing to OpenCDA-MARL! 🚀