Skip to content

Latest commit

 

History

History
125 lines (74 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

125 lines (74 loc) · 4.28 KB
Raw

Welcome to hyundai_kia_connect_monitor contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on hyundai_kia_connect_monitor ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/ZuinigeRijder/hyundai_kia_connect_monitor/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

hyundai_kia_connect_monitor could always use more documentation, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/ZuinigeRijder/hyundai_kia_connect_monitor/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up hyundai_kia_connect_monitor for local development.

  1. Fork the hyundai_kia_connect_monitor repo on GitHub.

  2. Clone your fork locally

    $ git clone https://github.com/your_name_here/hyundai_kia_connect_monitor.git
  1. Create a branch for local development
    $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Commit your changes and push your branch to GitHub
    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should pass the included tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
  3. The pull request should work for Python3.9 onwards

Tips

To run tests

C:\monitor> tests\run_tests.bat