|
|
@@ -0,0 +1,52 @@
|
|
|
+# Contributing to IQKeyboardManager
|
|
|
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
|
+
|
|
|
+- Reporting a bug
|
|
|
+- Discussing the current state of the code
|
|
|
+- Submitting a fix
|
|
|
+- Proposing new features
|
|
|
+
|
|
|
+## We Develop with Github
|
|
|
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
|
|
|
+
|
|
|
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
|
|
|
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
|
|
|
+
|
|
|
+1. Fork the repo and create your branch from `master`.
|
|
|
+2. If you've changed APIs, update the documentation.
|
|
|
+3. Make sure your code lints.
|
|
|
+4. Make same changes for Objective-C and Swift version of library.
|
|
|
+4. Issue that pull request!
|
|
|
+
|
|
|
+## 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. Feel free to contact the maintainers if that's a concern.
|
|
|
+
|
|
|
+## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
|
|
|
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
|
|
|
+
|
|
|
+## Write bug reports with detail, background, and sample code
|
|
|
+[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408).
|
|
|
+
|
|
|
+**Great Bug Reports** tend to have:
|
|
|
+
|
|
|
+- A quick summary and/or background
|
|
|
+- Steps to reproduce
|
|
|
+ - Be specific!
|
|
|
+ - Give sample code if you can. [Example stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce.
|
|
|
+- 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)
|
|
|
+
|
|
|
+People *love* thorough bug reports. I'm not even kidding.
|
|
|
+
|
|
|
+## Use a Consistent Coding Style
|
|
|
+I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
|
|
|
+
|
|
|
+* 2 spaces for indentation rather than tabs
|
|
|
+* You can try running `npm run lint` for style unification
|
|
|
+
|
|
|
+## License
|
|
|
+By contributing, you agree that your contributions will be licensed under its MIT License.
|
|
|
+
|
|
|
+## References
|
|
|
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
|
Mohd Iftekhar Qurashi