👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to ImageMapster.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.
Please do not use the issue tracker for personal support requests. For questions, how to's, etc. please see the Support Page for options.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thank you!
Guidelines for bug reports:
- Lint your code - Use eslint to ensure your problem isn't caused by a simple error in your own code.
- Use the GitHub issue search - Check if the issue has already been reported.
- Check if the issue has been fixed - Try to reproduce it using the latest
mainor development branch in the repository. - Isolate the problem - Create a reduced test case and a live example using the latest version of ImageMapster and preferrably, the latest version of jQuery/zepto.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Once you have established that there is a potential issue, please use the bug report issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information for the team to evaluate/reproduce.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project and search existing issues to see if your idea has already been requested.
Please use the feature request issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information to evaluate your proposal.
Good pull requests—patches, improvements, new features, etc. are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please use the pull request template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information to evaluate your proposal.
Please ask first before embarking on any significant pull request (e.g. implementing features or refactoring code), otherwise you risk spending a lot of time working on something that the project's maintainers might not want to merge into the project.
In lieu of a formal style-guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. If the type of unit test required to support your pull request is not supported by the current test framework (iqTest), please add an example covering the functionality. Please make sure your changes build by running grunt build as described in the development section of the Readme.
By contributing your code, you agree to license your contribution under the MIT License.