Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Introduction

First off, thank you for considering contributing to PIDArduino

PIDArduino is an open source project and we love to recieve cotributions from our community - you! There are many ways to contribute, from writing tutorials, improving the documentation, submitting bug reports and feature request or writing code for the actual library.

# Rules

* **§1:** Before submitting an issue, research to ensure it hasn't been submitted before. Avoid duplicate issues

* **§2:** Use common sense

# Getting started

*Please do not edit the master branch, always use the [develop](https://github.com/DonnyCraft1/PIDArduino/tree/develop) branch or a new feature branch when contributing!*

For something that is bigger than a one or two line fix:

1. Create your own fork of the repo
2. Create a new branch from the develop branch called `feature/new-feature`, all lower-case and replacing `new-feature` with a descriptive name for the feature
3. Do the changes in *your* fork
4. If you like the fork and think the project could use it, consider a pull request

---

Small contributions such as fixing spelling errors, can be submitted by a contributor as a patch directly on the [develop](https://github.com/DonnyCraft1/PIDArduino/tree/develop) branch.

This includes:

* Spelling / grammar fixes
* Typo correction, white space and formatting changes
* Comment clean up

# Commit message conventions

* The summary should be [capitalized](https://en.wikipedia.org/wiki/Capitalization) (first letter uppercase)

* The summary should *not* end with a period

* The summary should be short and descriptive

* The description should end with a period
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=PIDController
version=1.0.0
version=0.0.1
author=Daniel
maintainer=Daniel
sentence=A library that implements PID control to your code.
Expand Down