docs(templates): add github templates for issues and pull requests

Author: friedrith

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,43 @@
+<!--- Provide a general summary of the issue in the Title above -->
+
+<!--- Remember to follow CONTRIBUTING.md guidelines otherwise your issue will be closed -->
+
+## Expected Behavior
+
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Affected features
+
+- [ ] node API
+- [ ] cli
+
+## Possible Solution
+
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+
+1. 2. 3. 4.
+
+## Context
+
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+
+- OS:
+- node-wifi version
+- wifi card:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+<!--- Remember to follow CONTRIBUTING.md guidelines otherwise your pull request will be refused -->
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## Usage examples
+
+<!--- Provide examples of intended usage -->
+
+## How Has This Been Tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)

BIBLIOGRAPHY.md

@@ -4,3 +4,4 @@ Curated list of useful documentation for this project:
 
 - [The-way-to-fully-automated-releases-in-open-source-projects](https://medium.com/@kevinkreuzer/the-way-to-fully-automated-releases-in-open-source-projects-44c015f38fd6)
 - [Travis tutorial](https://docs.travis-ci.com/user/tutorial/)
+- [Example for github templates](https://github.com/conventional-changelog/commitlint/blob/master/.github)

CONTRIBUTING.md

@@ -2,25 +2,49 @@
 
 :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
-The following is a set of guidelines for contributing to node-wifi.
+## Found an Issue?
 
-1. Fork `node-wifi` repository
-2. Post an issue to propose your feature/improvement. It will be very useful to know if your idea has a chance to be accepted
-3. Implement your feature
-4. Test your feature
-5. Squash your commits into one
-6. Write your commit message following [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.3/)
-7. Create pull request for dev branch
+Thank you for reporting any issues you find. We do our best to test and make node-wifi as solid as possible, but any reported issue is a real help.
 
-> :information_source: Version 3 will be released soon and will provide a (lot of changes)[https://github.com/friedrith/node-wifi/projects/1]. Don't worry, everything will be retrocompatible. But it is every important to create an issue before proposing a pull request to integrate the fix
-> directly in the version 2 release.
+Please follow these guidelines when reporting issues:
 
-And please try to consider your development for windows, linux and macOS platforms at the same time
-because having a module compatible with all platforms is the main concern of `node-wifi`.
+- Provide a title in the format of `<Error> when <Task>`
+- Tag your issue with the tag `bug`
+- Provide a short summary of what you are trying to do
+- Provide the log of the encountered error if applicable
+- Provide the exact version of node-wifi.
+- Be awesome and consider contributing a [pull request](#want-to-contribute)
+
+## Want to contribute?
+
+You consider contributing changes to node-wifi – we dig that!
+Please consider these guidelines when filing a pull request:
+
+- Follow the [Commit Rules](#commit-rules)
+- Make sure you rebased the current master branch when filing the pull request
+- Squash your commits when filing the pull request
+- Provide a short title with a maximum of 100 characters
+- Provide a more detailed description containing
+  _ What you want to achieve
+  _ What you changed
+  _ What you added
+  _ What you removed
+- For significant changes, post also an issue before to know if your idea has a chance to be accepted
+- Consider your development for windows, linux and macOS platforms at the same time
+  because having a module compatible with all platforms is the main concern of `node-wifi`.
 
 **May the force be with you !!**
 
-## Conventional commits
+## Commit Rules
+
+To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
+
+- [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/)
+- husky commit message hook available
+- present tense
+- maximum of 100 characters
+- for bugs, includes the github tag of the issue in the description.
+- message format of `$type($scope): $message`
 
 These are the authorized types:
 
@@ -35,5 +59,3 @@ These are the authorized types:
 - revert
 - style
 - test
-
-And please include the reference to the issue or the pull request in the description.

README.md

@@ -165,11 +165,12 @@ Please read [development guidelines](./CONTRIBUTING.md) before proposing a pull
 ## Roadmap
 
 - [x] add conventional commits
-- [ ] plug to travis
-- [ ] add github templates
+- [x] plug to travis
+- [x] add github templates
+- [ ] add eslint
+- [ ] add prettier
 - [ ] switch to MIT license
 - [ ] install commitizen
 - [ ] rewrite the library using ES7
 - [ ] add unit tests
-- [ ] add eslint
-- [ ] add prettier
+- [ ] stdout how to reproduce bug