lighter-mime
Version:
A lightweight JavaScript MIME type library.
63 lines (47 loc) • 2.95 kB
Markdown
# Contributing to lighter-mime
We welcome contributions from the community and are happy to have them.
Please follow this guide when logging issues or making code changes.
## Logging Issues
All issues should be created using the
[new issue form](https://github.com/lighterio/lighter-mime/issues/new).
Please describe the issue including steps to reproduce. Also, make sure
to indicate the version that has the issue.
## Changing Code
Code changes are welcome and encouraged! Please follow our process:
1. Fork the repository on GitHub.
2. Fix the issue ensuring that your code follows the
[style guide](http://lighter.io/style-guide).
3. Add tests for your new code, ensuring that you have 100% code coverage.
(If necessary, we can help you reach 100% prior to merging.)
* Run `npm test` to run tests quickly, without testing coverage.
* Run `npm run cover` to test coverage and generate a report.
* Run `npm run report` to open the coverage report you generated.
4. [Pull requests](http://help.github.com/send-pull-requests/) should be made
to the [master branch](https://github.com/lighterio/lighter-mime/tree/master).
## Contributor Code of Conduct
As contributors and maintainers of `lighter-mime`, we pledge to respect all
people who contribute through reporting issues, posting feature requests,
updating documentation, submitting pull requests or patches, and other
activities.
If any participant in this project has issues or takes exception with a
contribution, they are obligated to provide constructive feedback and never
resort to personal attacks, trolling, public or private harassment, insults, or
other unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, edits, issues, and other contributions
that are not aligned with this Code of Conduct. Project maintainers who do
not follow the Code of Conduct may be removed from the project team.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting one or more of the project
maintainers.
We promise to extend courtesy and respect to everyone involved in this project
regardless of gender, gender identity, sexual orientation, ability or
disability, ethnicity, religion, age, location, native language, or level of
experience.
## Acknowledgements
We would like to thank all of the amazing people who use, support,
promote, enhance, document, patch, and submit comments & issues -
`lighter-mime` couldn't exist without you.
Additionally, huge thanks go to [eBay](http://rover.ebay.com/rover/1/711-53200-19255-0/1?icep_ff3=9&pub=5575137484&toolid=10001&campid=5337778482&icep_uq=node.js&icep_sortBy=12&ipn=psmain&icep_vectorid=229466&kwid=902099&mtid=824&kw=lg) for employing
and supporting [`lighter-mime`](http://lighter.io/lighter-mime) project
maintainers, and for being an epically awesome place to work (and play).