Skip to content

Commit 36d4a5a

Browse files
Updating contributing guidelines
Added a lot of information to the document.
1 parent b2e15e9 commit 36d4a5a

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
1-
# Contributing guide
1+
# Introduction
22

3-
***PLEASE READ***
3+
First off, thank you for considering contributing to PIDArduino
44

5-
This document includes guidelines for how to contribute to this repo.
5+
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.
6+
7+
# Rules
8+
9+
* **§1:** Before submitting an issue, research to ensure it hasn't been submitted before. Avoid duplicate issues
10+
11+
* **§2:** Use common sense
12+
13+
# Getting started
14+
15+
*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!*
16+
17+
For something that is bigger than a one or two line fix:
18+
19+
1. Create your own fork of the repo
20+
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
21+
3. Do the changes in *your* fork
22+
4. If you like the fork and think the project could use it, consider a pull request
23+
24+
---
25+
26+
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.
27+
28+
This includes:
29+
30+
* Spelling / grammar fixes
31+
* Typo correction, white space and formatting changes
32+
* Comment clean up
33+
34+
# Commit message conventions
35+
36+
* The summary should be [capitalized](https://en.wikipedia.org/wiki/Capitalization) (first letter uppercase)
37+
38+
* The summary should *not* end with a period
39+
40+
* The summary should be short and descriptive
41+
42+
* The description *should* end with a period

0 commit comments

Comments
 (0)