Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 3.38 KB

Contributing to @techbana/device-type-capture

If you have a question about @techbana/device-type-capture (not a bug report) please post it to techbana@gmail.com

Reporting bugs

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
    • Please post any relevant code samples, preferably a standalone script that reproduces your issue. Do not describe your issue in prose. Show your code.
    • If the bug involves an error, please post the stack trace.
    • Please post the version of @techbana/device-type-capture that you're using.
    • Please write bug reports in JavaScript (ES5, ES6, etc) / TypeScript that runs in Node.js and browser, not CoffeeScript, JSX, etc.

Requesting new features

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
  • Please describe a use case for it
  • Please include test cases if possible

Fixing bugs / Adding features

  • Before starting to write code, look for existing issues. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue here.
    • The source of this project is written in JavaScript and TypeScript, not CoffeeScript. Please write your bug reports in JavaScript/TypeScript that can run in vanilla Node.js and browser.
  • Fork the repo or for small documentation changes, navigate to the source on github and click the Edit button.
  • Follow the general coding style of the rest of the project:
    • 2 space tabs
    • no trailing whitespace
    • inline documentation for new methods, class members, etc.
    • 1 space between conditionals, no space before function parenthesis
      • if (..) {
      • for (..) {
      • while (..) {
      • function(err) {
  • Follow semantic versioning and release guidelines using semantic-release-cli and commit through git-cz
  • Write tests and make sure they pass.
  • Write typings-tests if you modify the typescript-typings.

Running the tests

  • Open a terminal and navigate to the root of the project
  • execute npm install to install the necessary dependencies
  • execute npm run build to build the code
  • execute npm test to run the tests

Documentation

To contribute to the documentation, just make your changes to the inline documentation of the appropriate source code in the master branch and submit a pull request. You might also use the github Edit button.

Financial contributions

We are not accepting any financial contribution right now. Thank you for considering though.

Credits

Contributors

Thank you to all the people who have already contributed to @techbana, looking forward for more! Your recognition would be added here and in readme.md as well. :)