🎉 Thanks for thinking about making a contribution! 🎉
The following is a set of guidelines for contributing to EEGEdu
. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
To start, you can find all the open issues here.
At any point in time you can create a pull request, so others can see your changes and give you feedback.
Start with a fork of the repository so you can work worry-free on your own fork.
You will need to fork once. Then, you can call git fetch upstream
and git pull 'branch-name'
before you do your local changes to fetch the latest remote changes make sure your changes are being made on up-to-date source code.
Configure your Dev Environment and make your changes on your fork.
Once you have made your changes, you can create a pull request, so others can see your changes and give you feedback. Create all pull requests on the master branch. If your PR is a work-in-progress, add a [WIP] at the start of the PR title. Example:[WIP] Heart Rate Monitor Module.
After each PR others will look into your feature, discuss the changes in the PR, and then merge into the master branch when changes are ready.