Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.57 KB

Contributing to Fakeit

🎉 Thanks for taking your time to contribute with Fakeit! 🎉

The following guide set some guidelines to contribute with Fakeit, please read it before start contributing.

General

How Can I Contribute?

General

  • Make an individual pull request / report for each suggestion / bug or enhancement.
  • Search previous suggestions before making a new one, as yours may be a duplicate, use the proper filters to help you with that.
  • Check your spelling and grammar.

How Can I Contribute?

Reporting Bugs

  • For reporting bugs please use the Github issue tracker.
  • The reported bug must start with the [Bug] tag along with a brief description of the bug.
  • If possible, add a step-by-step guide to reproduce it along with the crash stacktrace.
  • If running Fakeit on Android, add the Android API version.

Suggesting Enhancements

  • Use the Github issue tracker.
  • Use the [Feature] tag for features and the [Enhancement] tag for improvements.

Pull Requests

  • Before creating a PR, create an issue related to what you are fixing / improving.
  • Add a brief description and a link to the related issue.
  • Use a correct branch-naming:
    • For features use: feature/add-ru-locale
    • For fixes use: fix/crash-en-locale-name
    • For enhancements: enhancements/improve-fetch-code-style