Skip to content

Latest commit

 

History

History
67 lines (38 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

67 lines (38 loc) · 1.96 KB

Contributing

At the moment, the KivyMDBuilder project is not at the stage to make its source code publicly available. This means that the code is constantly changing and there is no point in making it public yet. But if you have any desire to help in the development of this project, you should know some of the features of this project:

Project details

  • The project architecture uses the MVС template - for detail
  • The project is modular. No part of the project depends on its components
  • You don't need to care about the user interface (this is the task of core developer of this project)

⚠️ You don't have to do any manipulation of the user interface either.

Your modules should only return a value.

How can I help?

At the moment, there are a number of tasks that need to be addressed:

  • Integration of Firebase into the project:

    Project

    Video tutorial

    The problem is, it doesn't work - bug details

  • Integration of AdMob services or their analogues

  • Minimum functionality for working with Git:

    GiHub authorization

    Creation of a password for subsequent logins

    Pull project

    Push project

    View changes

    ...

  • Python console

  • Bach console

  • System for creating and managing virtual environments

This list is far from complete. If possible, I will supplement every day. For questions related to the above list, you can contact the KivyMD server in the KivyMDBuilder (dev) section.

Code style

  • Each method of your modules should contain dos strings describing how this method works
  • Each parameter of your methods must contain the typ hinting of the arguments
  • The code must be formatted with the Black utility