mirrors/insomnia
1
0
Fork 0
mirror of https://github.com/Kong/insomnia synced 2024-11-07 22:30:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
10564b56a2
insomnia/CONTRIBUTING.md
Gregory Schier 10564b56a2 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 16:06:43 -07:00

2.9 KiB
Raw Blame History

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

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests (email 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.

Development Overview and Setup

# Install and use correct Node version
nvm install

# Actually use correct version
nvm use

# Install dependencies
npm install

When you run the development environment, it will start both a dev server and an Electron instance. The dev server is part of Webpack and is used to control hot module replacement of UI components. This means that, if you change a component file, you will not need to refresh the app to see the change. It will inject the new component immediately.

npm run dev