Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.53 KB
Raw

ELM327-emulator contribution guidelines

Contributions might involve:

  • Adding new core features
  • Adding a new plugin in the plugin directory
  • Providing a new dictionary file for a specific EQU or vehicle
  • Updating or adding pids/data in obd_message.py
  • Updating or adding AT messages in obd_message.py

In all these cases, we operate the "Fork & Pull" model explained at

https://help.github.com/articles/about-pull-requests/

First contributors can follow a tutorial page.

Please discuss the change you wish to make via an issue before developing a pull request.

Bugs

You can help to report bugs by filing an issue on the software or on the documentation.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of improper language
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.