Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

28 lines (16 loc) · 1.61 KB

Contributing to PolygonZone 🛠️

Thank you for your interest in contributing to PolygonZone!

Our goal with PolygonZone is to solve a problem that comes up time and time again in computer vision: figuring out the coordinates of a polygon that you want to draw on an image, a particular issue when you're trying to mark zones of interest in an image.

Contribution Guidelines

We welcome contributions to:

  1. Add a new feature to the web application (see more below).
  2. Report bugs and issues in the project.
  3. Submit a request for a new feature.

Contributing Features

PolygonZone is specifically designed to make it easy to retrieve the coordinates of a polygon that you want to draw on an image. If you have a feature that you think would: (i) improve the drawing experience; (ii) improve the general user experience; (iii) provide new import export functionalities or; (iv) otherwise improve PolygonZone, please submit an Issue to discuss the feature so the community can weigh in and assist.

How to Contribute Changes

First, fork this repository to your own GitHub account. Create a new branch that describes your changes (i.e. show-coordinates). Push your changes to the branch on your fork and then submit a pull request to this repository.

When creating new functions, please ensure you have the following:

  1. Comments where necessary that make it easier to understand how your code works.
  2. A written test that the project maintainers can follow to verify your code works as expected.

All pull requests will be reviewed by the maintainers of the project. We will provide feedback and ask for changes if necessary.