mirror of
https://github.com/Kong/insomnia
synced 2024-11-07 22:30:15 +00:00
d675222bdd
* Add Slack badge to README * Add Twitter badge * Appveyor badge * Fix badges again on README * Fix Twitter badge link * Simplify README.md * Migrate Travis secure items to Travis project settings (#198) * Remove docker linux build (using Travis now) (#199) * Fix travis build * Update Issue and PR templates (#200) * Add template for future pull requests * Format issue template like pull request template * Will not clear selected file if dialog is dismissed (#202) * #183, Body type "Text -> Other" reverts to previous body type (#193) * ISSUE#183 * Adding condition to check mime-type to other * Removing older changes for fixing issue. * Save full response to a file (#207) * Save full response to a file * Add a new button on the response preview pane * Save full response to file when button clicked * Update after PR comments * It's a Response, not a Request * Remove file extension requirement * Implement lazy tag rendering and some fixes (#211) * expanding to 3 decimals (#213) * Update PULL_REQUEST_TEMPLATE.md (#214) * Show build info in console (#216) * Add waiting message in dev mode while webpack compile happens * Switch license from GPL to AGPL (#221) * Default remote URLs to production * Don't use Curl's cookie handling (#220) * Some improvements to the response tag * Add tests for XPath response queries * Refactor conditional element syntax * Add option to toggle Menu Bar showing for Windows/Linux (#225) * Add option to toggle MenuBar showing on Windows/Linux * Extract Toggling Menu Bar functionality to App Container. Default show Menu Bar. Remove tip from Response Pane. * Finalize {% response ... %} Tag (#224) * Some improvements to the response tag * Add tests for XPath response queries * Refactor conditional element syntax * Update nunjucks-tags.js * Better Nunjucks Tag Editor (#234) * Helper to tokenize Nunjucks tag * More granular types * Add tag definitions * Improve editor to be more WYSIWYG * Fixed tests * Added raw response tag * A few improvements to tag editor enum * fix NTLM typo (#244) * Tweaks and fixes for next release (#245)
61 lines
2.4 KiB
Markdown
61 lines
2.4 KiB
Markdown
# 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
|
|
|
|
[GitHub Issues](https://github.com/getinsomnia/insomnia/issues) is the preferred channel
|
|
for [bug reports](#bug-reports), [features requests](#feature-requests)
|
|
and [submitting pull requests](#pull-requests).
|
|
|
|
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
|
|
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
|
|
to fix any potential bugs.
|
|
|
|
## Feature Requests
|
|
|
|
Feature requests are welcome. But take a moment to find out whether your idea
|
|
fits with the scope and aims of the project. It's up to *you* to make a strong
|
|
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),
|
|
otherwise you risk spending a lot of time working on something that might
|
|
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.
|