Skip to content
Permalink
Browse files

Create contributing.md

  • Loading branch information
noisymime committed Oct 26, 2016
1 parent 9033811 commit 0d4994f884a70364236eb2a3f27af862c9db6b72
Showing with 36 additions and 0 deletions.
  1. +36 −0 contributing.md
@@ -0,0 +1,36 @@
# How to contribute

The Speeduino project is always looking for new contributors so thanks for your interest in this!

If you haven't already, jump onto our Slack team as that is where most of the development discussion takes place: https://speeduino.com/forum/app.php/page/slack

Here are some important resources:

* [Coding style guide](http://speeduino.com/wiki/index.php/Style_code)
* [Project forum](https://speeduino.com/forum)
* [Slack team](https://speeduino.com/forum/app.php/page/slack)

## Testing

All contributions should be in a working, compilable state. If your change does not compile cleanly it will be rejected immediately.

## Submitting changes

Please send a [GitHub Pull Request to Speeduino](https://github.com/noisymime/speeduino/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).

Please try to make each pull request atomic, that is, there should be a single defined intent or feature for the pull request. If you are adding multiple features or fixing different bugs, please split these up and submit multiple pull requests.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
## Contributor Licensing
Note that all contributions to the project are made under the Github Contributor Lincensing Agreement: https://cla.github.com/agreement
This ensures that all contributions made to the project are licensed in the same way as the existing work. Such an agreement is not intended to deprive contributors of their copyright, but to protect the project from claims by malicious contributors.

## Coding conventions

The coding style guide can be found on the project wiki: http://speeduino.com/wiki/index.php/Style_code

1 comment on commit 0d4994f

@VitorBoss

This comment has been minimized.

Copy link
Contributor

VitorBoss commented on 0d4994f Oct 26, 2016

Thank you for explain, I'm sorry if I didn't follow the codding rules before.

Please sign in to comment.
You can’t perform that action at this time.