mirrors/insomnia
1
0
Fork 0
mirror of https://github.com/Kong/insomnia synced 2024-11-07 06:12:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
359d7e3271
insomnia/CONTRIBUTING.md

42 lines
2.9 KiB
Markdown
Raw Normal View History

Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
# Contributing to this project
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
## Using the issue tracker
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
[GitHub Issues](https://github.com/kong/insomnia/issues) is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests) and [submitting pull requests](#pull-requests).
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
Please respect the following restrictions:
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
- Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
## Bug Reports
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
Guidelines for bug reports:
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
1. **Use the GitHub issue search** — check if the issue has already been reported.
1. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
1. **Demonstrate the problem** — provide clear steps that can be reproduced.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
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.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
## Feature Requests
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
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.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
## Pull Requests
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
Good pull requests (patches, improvements, new features) are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
**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.
Final prep for v5 launch (#128) * Version number and changelog scroll * Fixed CodeMirror tooltip css * AUtocomplete dropdown styling * Docker Ubuntu build and some tweaks * Fix SSL verificatioN * Don't show SSL data * Update README * Fixed URL paste handler * Import from curl improvements * Minor things
2017-04-04 23:06:43 +00:00
docs: update links and minor typo (#4809)
2022-09-07 10:34:51 +00:00
If you plan on helping with development, please read the [Develop Insomnia](README.md#develop-insomnia) section of the README for how to get started. The [Development Overview](DEVELOPMENT.md) may also prove useful for a general overview of the application architecture.
docs: revise contributing, development, and readme (#4801) Co-authored-by: Dimitri Mitropoulos <dimitrimitropoulos@gmail.com>
2022-05-20 12:36:28 +00:00
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
**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.
Add Contributor Shirt Details (#2135)
2020-05-08 00:20:27 +00:00
## Contributor T-shirt
adds markdown linting (#3931)
2021-08-27 03:44:01 +00:00
Add Contributor Shirt Details (#2135)
2020-05-08 00:20:27 +00:00
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).
Reference in New Issue Copy Permalink