Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

91 lines (63 loc) · 4.35 KB

Contributing to DriveQu

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for me maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And 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 I will also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the DriveQu Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to iamfebriadji@gmail.com.

Question

If you want to ask a question, I assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, I recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

I will then take care of the issue as soon as possible.

Contribute

Legal notice! when contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to iamfebriadji@gmail.com.

I use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Your First Code Contribution

  1. Fork this project
  2. Clone to your local repository 
    $ git clone https://github.com/{user}/drivequ.git

$ cd drivequ && code .
  3. Create a new branch 
    $ git checkout -b features/yourchanges
  4. Commit your changes 
    $ git add

$ git commit -m "feat: Add new features"

$ git push origin {branch}
  5. Open a pull request

Style Guide

Important! as a contributor, you must follow the style guide below

Code Style: AirBnB
Commit: Conventional Commits