Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.24 KB

Contributing to Uploadcare

Thanks for taking the time to contribute to our API wrappers & Uploaders!

Uploadcare consists of:

  • Upload API to upload files
  • REST API to manage uploaded files, file groups, and projects
  • Transformations to transform uploaded files on-the-fly
  • Uploaders (web, iOS, and Android) which replaces system uploader with a powerful customizable UI

Take a look at our documentation to find out how it works.

How to contribute

  • Create an issue or send us an email at hello@uploadcare.com (if you want to discuss anything with us beforehand).
  • Fork, commit, push.
  • Submit a pull request to this repository.
  • The repository team will aim to look at the pull request as soon as possible, provide feedback where required and merge when it is deemed a satisfactory addition.

If you're going to build a completely new library, contact us at hello@uploadcare.com, we're more than willing to help!

Coding conventions

  • Write tests
  • Write documentation
  • Add changelog stub or use conventional commit messages
  • Run auto-formatters
  • Run linters
  • Run tests
  • Follow the relevant coding conventions mentioned in the repository README.md