Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 1.92 KB
Raw

Adminio UI Contribution Guide

The owners of this repository welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide.

Development Workflow

Start by forking the this GitHub repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details:

Setup your adminio-ui GitHub Repository

Fork Adminio ui upstream source repository to your own personal repository.

Set up git remote as upstream

$ git clone https://github.com/rzrbld/adminio-ui
$ cd adminio-ui
$ git remote add upstream https://github.com/rzrbld/adminio-ui
$ git fetch upstream
$ git merge upstream/master
...

Create your feature branch

Before making code changes, make sure you create a separate branch for these changes

$ git checkout -b my-new-feature

Test changes

After your code changes, make sure

  • To run ng build and see on errors
  • To squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
  • To run some tests.

Commit changes

After verification, commit your changes. This is a great post on how to write useful commit messages

$ git commit -am 'Add some feature'

Push to the branch

Push your locally committed changes to the remote origin (your fork)

$ git push origin my-new-feature

Create a Pull Request

Pull requests can be created via GitHub. Refer to this document for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged.

FAQs

How does adminio-ui manages dependencies?

adminio-ui uses npm to manage its dependencies.

  • Run npm i foo/bar --save in the source folder to add the dependency.