Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.76 KB
Raw

Contributing to Fake-SpeedTest-Generator

First off, thanks for taking the time to contribute! We want to make contributing to this project as easy and transparent as possible.

If you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Sending feedbacks
  • Reporting bugs
  • Submitting new ideas
  • Improving the documentations

Table of Contents

Code of Conduct

Help us keep Fake-SpeedTest-Generator open and inclusive. Please read and follow our Code of Conduct.

Steps to Contribute

  1. Pick an issue from Issue tab or create one if you have something to contribute
  2. Fork this repository (Forking a Repo)
  3. Clone your forked repo into your local machine (Cloning a Repo)
  4. Create a branch (Branch Name)
  5. Commit your changes
  6. Create a pull request (How to create a Pull Request)

Picking an Issue

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment.

Branch Name

Create a branch according to the issue that you're working on. The naming convention is as following:

TYPE-ISSUE_ID-DESCRIPTION

example:

feat-56-add-contributing-guidelines

When TYPE can be:

  • feat - is a new feature
  • doc - documentation only changes
  • fix - a bug fix
  • refactor - code change that neither fixes a bug nor adds a feature

All PRs must include a commit message with the changes description!

Pull Request

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

When creating a pull request, make sure all the prior functionality still working as intended. Remove any unecessary comments, log, or dead code. Attach a screenshot if your changes is related to UI changes. Don't forget to describe what are the changes in that pull request.