Skip to content

Commit

Permalink
Add contribution guideline (#28)
Browse files Browse the repository at this point in the history
add a contribution guideline
  • Loading branch information
designer2k2 authored Dec 8, 2024
1 parent fb473d8 commit 661aa3e
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# How to contribute to EMUcan

## **Did you find a bug?**

- Open a New Issue and describe the Bug so that it can be reproduced.

- The more information you put inside, the better!

## **Did you write a patch that fixes a bug?**

- Open a new GitHub pull request with the patch.

- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

## **Do you intend to add a new feature or change an existing one?**

- Open a New Issue and describe it.

- If you have the code ready, open a new GitHub pull request. Include the relevant issue number in the description.

## **Do you have questions about the source code?**

- Open a New Issue with the question.

## **Automated code checks**

Any PR is checked with the help of GitHub Actions for:

- Spelling and natural language.

- Formatting against the build autoformat of the Arduino IDE, [STRG]+[T] / [CMD]+[T]

Thanks! :heart: :heart: :heart:
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ It reads the EMU CAN Stream and decodes it into something useful.

This works with any CAN enabled device, MCP2515, Teensy, ESP32, STM32, Arduino UNO R4 and more.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![arduino-library-badge](https://www.ardu-badge.com/badge/EMUcan.svg?)](https://www.ardu-badge.com/EMUcan) [![CI badge](https://github.com/designer2k2/EMUcan/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/designer2k2/EMUcan/actions) [![CI badge](https://github.com/designer2k2/EMUcan/actions/workflows/unit-test.yml/badge.svg)](https://github.com/designer2k2/EMUcan/actions)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![arduino-library-badge](https://www.ardu-badge.com/badge/EMUcan.svg?)](https://www.ardu-badge.com/EMUcan)
[![CI badge](https://github.com/designer2k2/EMUcan/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/designer2k2/EMUcan/actions)
[![CI badge](https://github.com/designer2k2/EMUcan/actions/workflows/unit-test.yml/badge.svg)](https://github.com/designer2k2/EMUcan/actions)
[![Super-Linter](https://github.com/designer2k2/EMUcan/actions/workflows/super-linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)

**Content:**
Expand Down Expand Up @@ -258,3 +261,4 @@ Please see in the examples on how to make this happen on MCP2515, Teensy and ESP
### Support

Please feel free to use/extend/report bugs/request features!
Take a look at the [Contribution Documents](https://github.com/designer2k2/EMUcan/blob/main/CONTRIBUTING.md) to see how to it.

0 comments on commit 661aa3e

Please sign in to comment.