Skip to content

Latest commit

 

History

History
executable file
·
37 lines (23 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
37 lines (23 loc) · 1.97 KB

Contributing

🎉🥂 First off, thanks for taking the time to contribute! 🎉🥂

Contributions are always welcome, no matter how small.

The following is a small set of guidelines for how to contribute to the project

Where to start

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating you are expected to adhere to these expectations. Please report unacceptable behaviour to [email protected]

Contributing on Github

If you're new to Git and want to learn how to fork this repo, make your own additions, and include those additions in the master version of this project, check out this great tutorial.

Community

This project is maintained by the OpenBCI community. Join the OpenBCI Forum, where discussions about OpenBCI takes place.

How can I contribute?

This is currently a small, humble project so our contribution process is rather casual. If there's a feature you'd be interested in building, go ahead! Let us know on the OpenBCI Forum or open an issue so others can follow along and we'll support you as much as we can. When you're finished submit a pull request to the master branch referencing the specific issue you addressed.

If you find a bug, or have a suggestion on how to improve the project, just fill out a Github issue

Steps to Contribute

  1. Fork it!
  2. Branch off of development: git checkout development
  3. Create your feature branch: git checkout -b my-new-feature
  4. Make changes
  5. Commit your changes: git commit -m 'Add some feature'
  6. Push to the branch: git push origin my-new-feature
  7. Submit a pull request. Make sure it is based off of the development branch when submitting! :D