Kory Mathewson
fd86a5f3c2
Making some changes to CONTRIBUTING to make sure that we are ready to go live and invite contributions.
35 linhas
1.4 KiB
Markdown
35 linhas
1.4 KiB
Markdown
|
|
🎉 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.
|
|
|
|
# Issues
|
|
|
|
To start, you can find all the open issues [here](https://github.com/kylemath/EEGEdu/issues).
|
|
|
|
# Pull Requests (PR)
|
|
|
|
At any point in time you can create a pull request, so others can see your changes and give you feedback.
|
|
|
|
# Setup
|
|
|
|
## Fork the Repository
|
|
|
|
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.
|
|
|
|
## Make Development Environment and Change Away
|
|
|
|
Configure your Dev Environment and make your changes on your fork.
|
|
|
|
# Contributing
|
|
|
|
## Creating a Pull Request
|
|
|
|
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.
|
|
|
|
## Wait for Reviews
|
|
|
|
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.
|