Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 3.17 KB

CONTRIBUTE.md

File metadata and controls

71 lines (42 loc) · 3.17 KB
Raw

Contributing to MobileUI Components

First off, thanks for taking the time to contribute! 👍 We do our best to accept all PRs that can improve this project! 🎉

The following is a set of guidelines for contributing to MobileUI Components and its packages, which are hosted in the MobileUI organization here at Github. These are mostly guidelines to help you guys get started and not rules. Use your best judgement, and feel free to propose changes to our project through a pull request. 😄

What should I know before contributing?

MobileUI is an open source project created thinking of making your hybrid applications faster and smaller. It helps a lot since you're not required to install the whole package, you only install what you need to get started in building your application. 🎉

Certainly, you will love using it in Progressive Web Apps and Apache Cordova Apps. You can use only the components you want in your projects created with PhoneGap, Ionic Framework, Onsen UI, Framework7 and others focused on creating web apps.

A rich variety of UI components specially designed for mobile apps. MobileUI provides tabs, side menu, stack navigation and tons of other components such as lists and forms. Some of the existing components are displayed differently on Android and iOS, with automatic styling that will change the appearance of the app based on the platform.

To know more --- check out the official documentation

Getting Started

Process of creating a new component

  1. In the project's root dir, create a folder named after the component you will create, for example list or chart-bar.

  2. Create a file named component.json inside the folder. The content of the component.json file should follow this structure:

{
  "name":"chart-bar",
  "author": "fabiorogeriosj",
  "dependencies": [
    "base"
  ]
}
  1. Test and document your component in an HTML file inside your component's folder.

Include usage examples and all the options that your component accept so other people can use the component correctly!

  1. Open a Pull Request against the master branch

  2. Wait for review and discussion.

If we don't respond within a few days, send a message in the PR thread! =)

  1. Your code will be merged if accepted!

Re-generating MobileUI documentation

  1. Fork and clone (your fork) components repo and mobileui.github.io repo inside the same parent folder.
__ parent/
  |_ components/
  |_ mobileui.github.io/
  1. With your terminal, inside the components project, execute the generate_docs.js with node:
node generate_docs.js

  1. Then, new files should be generated at mobileui.github.io folder. Now it's simple: add and commit these files to your fork project.

  2. At GitHub, open the PR from your fork of mobileui.github.io to our repository with this commit with the new generated files.

  3. We'll check and, if everything is ok, accept your merge!