# Contributing Thanks for your Help! :boom: - Reporting a bug - Submitting a fix - Proposing new features --- **Project installation & structure** install: ```bash git clone https://github.com/BauViso/angular-suneditor.git cd npm install ``` running tests: ```bash npm run test-lib:watch ``` ## Pull Requests *Make sure your change make some kind of improvments or fixes* **A Pull request needs to contain** - Testing (when needed) - Documentation (code and README) - An understandable explanation for the reason **Create a Pull Request** 1. Fork the repo and create your branch from `master` 2. Make your changes 4. Ensure the test suite passes 6. Issue that pull request --- ## Report bugs Report a bug by [opening a new issue: Bug report](https://github.com/BauViso/angular-suneditor/issues/new?assignees=&labels=&template=bug_report.md&title=) **Great Bug Reports** tend to have: - A quick summary and/or background - Steps to reproduce - Be specific! - Give sample code if you can - What you expected would happen - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) --- ## Request a feature Report a Feature Request by [opening a new issue: Feature request](https://github.com/BauViso/angular-suneditor/issues/new?assignees=&labels=&template=feature_request.md&title=) **Great Feature Request** tend to have: - A quick summary - Explaination of the feature (try to be specific) - What is your usecase? Why is this feature needed? - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) *You can include code - but this will only be adopted when the feature has been accepted and and the code has been reviewed* --- ## Any contributions you make will be under the MIT Software License In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project.