Skip to content
This repository was archived by the owner on Jul 21, 2019. It is now read-only.

Latest commit

 

History

History
61 lines (44 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

61 lines (44 loc) · 1.98 KB

Contributing

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Download

Similar to the instructions in README.md, but with the whole git history included.

$ git clone https://github.com/KenanY/nwitch.git
$ cd nwitch
$ npm install

Bug reports

A bug is a demonstrable problem that is caused by nwitch's source code. 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 branch in the repository.

A good bug report shouldn't leave me needing to chase you up for more information. Please try to be as detailed as possible in your report.

Feature requests

Feature requests are extremely welcome. However, first consider if your idea is within the scope and aims of this project. In the end, it's up to you to make a strong case to convince me 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 or refactoring code), otherwise you risk spending a lot of time working on something that I might not want to merge into the project.

Coding style

  • 2 spaces for indentation
  • Semicolons
  • Single quotes
  • Open braces go on the same line as the statement
  • One variable per var statement
  • Use lowerCamelCase for variables, properties and function names
  • Use UpperCamelCase for class names
  • Use UPPERCASE for constants

IMPORTANT: By submitting a patch, you agree to allow me to license your work under the same license as that used by nwitch.