Skip to content

Latest commit

 

History

History
40 lines (36 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

40 lines (36 loc) · 1.8 KB

How to contribute:

You're free to contribute with us. Make an issue or pull request.

  • Use a clear and descriptive title for requests to identify the suggestion.
  • Use markdown.
  • Make sure if you won't duplicate request.

Pull request

  • Make sure your code follows the code style of this project.
  • Make sure if it works and it's TESTED
  • Describe what've you done and why, clearly and concisely.
  • Let us know if you updated documentation or it needs update.
  • Check types of changes.

Bug report - Create a report to help us fix a bug

  • Make sure if this bug is strict related to this project
  • Make sure if you problem is not reported yet
  • Always make a clear and concise description
  • Paste Error information
  • Describe the bug
  • Write your expected behavior
  • Tell how to reproduce
  • Fix suggestion
  • Screenshots
  • Additional context
  • Evironment

Feature request - Suggest an idea

  • Make sure if your request isn't reported yet
  • Always make a clear and concise description
  • Is your feature request related to a problem? If so, describe it
  • Have you considered any alternatives? If so, describe them
  • Do you have any screenshots to show it visually? If so, send it
  • How big is change?

Help request - You don't understand something in project and need help.

  • Make sure if this request doesn't exist yet
  • Make sure if you read tutorial/documentation (if exsts)
  • Make sure if this request is strict related to this project
  • Describe you problem clear and concisely
  • Describe what you've done so far (paste code)