Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.56 KB

contributing.md

File metadata and controls

21 lines (15 loc) · 1.56 KB

Contributing

Ware is an open source project thats helps others build dekstop progressive web apps (DPWA), utilizing our framework to speed up development. Hopefully this document makes the process for contributing clear and answers some questions that you may have!

Semantic Versioning

Ware follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes.

How to Contribute

You can contribute with a suggestion(s) by creating an issues or by adding new features with a pull request. Bellow are the steps required to create a pull request.

  1. Fork the repository and create your branch from master with git branch -b feature/_name_.
  2. Run npm i in the repository root to install all the project dependencies.
  3. Run npm run docz to start the development enviroment. More on Docz.
  4. Create new components, update old ones, and play around in the documentation playground.
  5. Build some test and ensure the test suite passes (npm run test).s
  6. Bump the version acording to Semantic Versioning (npm version [major | minor | patch])
  7. Build the docz docs npm run build.
  8. Commit all changes (git add . & git commit -m 'my message') and npm publish your feature branch.
  9. In GitHub go and create an Pull request by setting base:master and compare: your-branch-name.