Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.25 KB

Contributing to BlackTie.js

First of all thanks for taking your time and coming here!

This file here has a set of guidelines to follow when contributing to this project.

How Can I Contribute?

Reporting Bugs

  • Please use GitHub issues tracker in Issue template format to report any new bugs found.
  • Please use a clear and descriptive title for the issue to identify the problem.
  • Describe where you experienced this issue and what you think should have happened. (Eg. When pressing right, character is moving left. But it should be moving right.)
  • Please send a pull request for all contributions even if it is a single line code change. This helps keep a clean code base.
  • Add proper commit messages and comments so that it will be easier to review the code changes.

Ground Rules & Responsibilities

  • Ensure cross-platform, cross-browser and cross-device compatibility for every change that's accepted. All major web browsers should be supported, android, ios, mac and windows.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed.
  • Please use vanilla javascript whenever possible.