---

layout: default title: Contributing to Smoothieware —

Contributing

The Smoothieware project is always looking for help.

Whatever your skills are, there are things you can do to improve the project with other volunteers.

Help and working together is what has made this project so advanced and precious over the years, and is very welcome.

We appreciate all contributions, whether it's code, documentation, bug reports, or helping other users in the community!

Getting Started

Here is a list of the useful resources you want to read if you want to contribute to the project:

• Coding standards - Defines what your code should look like

• Contribution guidelines - Lists the dos and don’ts of proposing a contribution

• Github - Explains the proper procedure to submit a new feature via Github

• Developer’s guide - Points at a few useful things about the codebase

• How to file an issue - Explains everything you want to do when filing a new issue on Github

Ways to Contribute

Code Contributions

If you can code, there are always features to implement and bugs to fix.

Check the Todo list for current priorities.

Documentation

Help improve this documentation by fixing errors, adding examples, or writing new guides.

See Editing the Wiki for instructions.

Community Support

Answer questions on IRC, the forum, or mailing lists.

Helping other users is a valuable contribution!

Testing

Test new features on different hardware configurations and report your findings.

Beta testing helps catch issues before releases.

Contact

If you want to contribute but aren’t sure how, please contact us.

We’ll help you find something that matches your skills and interests!

How to submit a pull request to the Smoothieware Github project

We use edge as our stable branch (master is no longer maintained). We do not have an unstable branch, so this is why we only allow very well tested PRs into edge.

Fork the original repository

Create a Fork in your GitHub of Smoothieware repository by clicking the Fork button.

You will now have a forked repository in your list of repositories.

Clone the forked repository

You can get the URL for cloning that repository by clicking the copy URL button.

On your local workstation clone the repository: git clone <your GitHub fork of Smoothie>

Create a new branch for your bugfix / feature

Create a fix branch with a descriptive name: git checkout -b fix/some-error

NOTE only one feature/bug fix per branch please

Edit the file to fix the error.

Please

• Check the fix!!!
• Make sure your changes are coincide with our coding standards! (use 4 spaces per indent and not tabs, etc.)

Commit your changes and push it back on GitHub

Commit the changes: git commit -am 'introduced lots of bugs'

Push the branch to your GitHub: git push origin fix/some-error

Submit your pull request

In GitHub, there should be a button that says pull request for that branch, click it.

Select edge as the destination branch, add comments.

Please

• Check the Files Changed Tab in GitHub to make sure only the files you want to change are listed.
• Check that only the lines you want changed are changed.

Finally, submit the pull request.

Want to learn Git?

Try this game.