2017-04-04 23:06:43 +00:00
# Contributing to this project
Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.
## Using the issue tracker
2019-12-17 17:16:08 +00:00
[GitHub Issues ](https://github.com/kong/insomnia/issues ) is the preferred channel
2019-11-22 18:31:23 +00:00
for [bug reports ](#bug-reports ), [features requests ](#feature-requests )
2017-05-24 16:25:22 +00:00
and [submitting pull requests ](#pull-requests ).
2017-04-04 23:06:43 +00:00
Please respect the following restrictions:
- Please **do not** use the issue tracker for personal support requests (email
[support@insomnia.rest ](mailto:support@insomnia.rest )).
- Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.
## Bug Reports
A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Use the GitHub issue search** — check if the issue has already been
reported.
2. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.
3. **Demonstrate the problem** — provide clear steps that can be reproduced.
A good bug report should not leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
2019-11-22 18:31:23 +00:00
your environment? What steps will reproduce the issue? What OS experienced the
problem? What would you expect to be the outcome? All these details will help
2017-04-04 23:06:43 +00:00
to fix any potential bugs.
## Feature Requests
Feature requests are welcome. But take a moment to find out whether your idea
2019-11-22 18:31:23 +00:00
fits with the scope and aims of the project. It's up to _you_ to make a strong
2017-04-04 23:06:43 +00:00
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
## Pull Requests
Good pull requests (patches, improvements, new features) are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code, porting to a different language),
2019-10-09 18:55:21 +00:00
otherwise, you risk spending a lot of time working on something that might
2017-04-04 23:06:43 +00:00
not get accepted into the project.
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
license your work under the same license as that used by the project.
2020-05-08 00:20:27 +00:00
## Contributor T-shirt
If your pull request to [Kong/insomnia ](https://github.com/Kong/insomnia ) was accepted, and it fixes a bug, adds functionality, or makes it significantly easier to use or understand Insomnia, congratulations! You are eligible to receive the very special contributor t-shirt! Go ahead and fill out the [contributor submission form ](https://goo.gl/forms/5w6mxLaE4tz2YM0L2 ).
