Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.55 KB
Raw

Contributing to DROPEX

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Reporting bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. It would be helpful if you add the environment details and the steps to reproduce the bug.

Add images or animated GIFs to help explain the bug if possible.

How to contribute

To contribute to DROPEX, follow the steps listed in main README.md) file. After performing the steps, note to install the below packages:

pip install ruff black

Once done you can start working on the fix or new feature and submit a pull request.

Pull Requests

  • Create a Pull Request from a new branch after forking it.
  • Fill in the required template
  • Include screenshots and animated GIFs in your pull request whenever possible.

Contributing to the simulation

The simulation is majorly supported using a WEBGL based app created using Unity Engine and the source code can be found here: DROPEX-simulation. Any contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. These have to be contribute to the simulation repository.