Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.93 KB

Contributing to KivyMD

I need a support

  • Do not create an issue. You can find support information in README.

I found a bug

  • Check that this bug isn't already reported: issues on GitHub.
  • Create new issue with Bug report template.
  • Write good title and clear description, paste code sample and, if possible, attach a screenshot.

I want to suggest a new feature

  • Check that similar feature isn't already published: issues on GitHub.
  • Create new issue with Feature request template.
  • Write good title and clear description, paste code sample and, if possible, attach an images.

I have a changes

  • Check that similar changes isn't already requested: pull requests on GitHub.
  • Format your code with Black utility. Use pre-commit to automatically format code before commit.
  • Do not forget to test your code.
  • Create new pull request.
  • Write good title and description of changes and, if possible, attach a screenshots.

What contributions can I make?

See TODO List

Documentation

All Python code should be documented. Properties are documented in Kivy style

Make widgets fit Material Design

All widgets should look like it drawn in Material specification: https://material.io/components/

Make widgets more customisable

Widgets should have as many properties as may be required to customize it.