Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

103 lines (70 loc) · 3.1 KB
Raw

Contributing to karma-loud

Want to help? Great! The following is a set of guidelines for contributing.

Branch for Pull Requests

master

How to help?

  • Generate new ideas and particiate in discussion
  • Fix typos and clarify language, keep content easy to read
  • Find and report bugs, fix them

Reporting Issues

Bugs

Check if someone has already reported the issue. If it does, add a “+1” or “I have this problem too”. This helps decide on priorities.

If nothing found, create an issue and report:

  • What’s happening and your expectation
  • Steps to reproduce
  • Your environment (OS, browsers)
  • What would you expect to be the outcome?

Be as detailed as possible.

Questions

Please, don’t create issues for asking questions, use StackOverflow instead.

Testing Changes

Please, submit tests for your contribution.

Try to keep code coverage at 100%.

Following Conventions

Code Style

Follow the EditorConfig rules placed in the .editorconfig file:

  • Indentation: 4 spaces
  • End of line: LF (Unix)
  • Recommended line length limit: 72 characters

JavaScript code style is as follow:

  • Single-quoted strings
  • Whitespace after reserved words, between operators, after comma
  • Declare variables at the beginning of functions
  • Use === and !== instead of == and !=

Please, follow coding conventions already used in the edited file even if these conventions contradict the rules above.

Commit message

Please, make commits of logical units and describe them properly.

  • Write in plain English.
  • Explain the issue, not the actions
  • Use the present tense (“Fix an issue”, not “Fixed an issue”)
  • Use the imperative mood (“Fix an issue”, not “Fixes an issue”)
  • On the first line, line length limit is 50 characters; don’t place a dot at the end of the line
  • Second line is blank
  • On the next lines, line length limit is 72 characters

Granting License

By contributing to this repository, you and the company you represent, if the company holds any copyrights in the contribution, grant to Ruslan Sagitov a perpetual, non‑exclusive, royalty‑free, world‑wide right and license under all of your copyrights in this contribution to copy, publish, use, and modify the contribution and to distribute the contribution under a MIT License or one with more restrictive terms, as well as a right and license of the same scope to any derivative works prepared by Ruslan Sagitov and based on or incorporating all or part of the contribution. You further agree that any derivative works of this contribution prepared by Ruslan Sagitov shall be solely owned by Ruslan Sagitov.

You state, to the best of your knowledge, that you, or the company you represent, have all rights necessary to contribute the materials.

Being Nice

Please, avoid unstructured critique. Any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.

Thanks ❤️