27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# Contributing to Ionic Material
|
|
## General
|
|
- When posting an issue please include a codepen or plunkr and instructions to reproduce.
|
|
|
|
## Development
|
|
### Workflow
|
|
1. **Create an [Issue](http://github.com/webchat/webchat-hybrid/issues)** (feature/bug/enhancement)
|
|
- Issues are our to-do list.
|
|
- Check for an existing issue related to subject
|
|
2. **Use [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/)**
|
|
a. Fork and Make Feature/Hotfix Branch
|
|
- If simple, write unit tests
|
|
- Implement solution for feature/hotfix
|
|
- Run tests
|
|
3. **Commit**
|
|
- **NB:** Please Use [Conventional Changelog Commit Guidelines](http://github.com/ajoslin/conventional-changelog/blog/master/)
|
|
+ use [commitizen](https://github.com/commitizen/cz-cli) to make your life easier with this
|
|
+ Remember to reference related issues, e.g: `"fixes #123"`
|
|
4. Submit a **Pull Request** for finished feature/hotfix
|
|
5. Merge PR if no conflicts.
|
|
|
|
Rinse & Repeat until all Ionic Apps look amazing and materialized.
|
|
|
|
### Running Tests (TODO)
|
|
<!-- TODO: Tests Documentation -->
|
|
- blah blah blah Karma etc.
|