EEG-Workflow-System

Contributing to EEG Workflow System

Thanks for checking out our contribution guide. We greatly appreciate any work contributed, no matter how small!

How to Contribute

When you are ready to start work on an issue:

• Let us know by leaving a comment on the issue. (Also let us know later if you are no longer working on it.)
• Once you are assigned the issue (or once you have claimed the issue) only then proceed to make the Pull Request. This will help avoid multiple PRs pertaining to the same issue.

If you don’t see your idea listed, do one of the following:

• If your contribution is minor, such as a typo fix, open a pull request.
• If your contribution is major, such as a new feature/enhancement, start by opening an issue first. That way, other people can be also involved in the discussion before you do any work.

Pull Request Process

1. Create a branch. For example, if you are going to work on issue number #19 (which is, say, a new feature for ‘workflow execution’ management):

    git checkout -b workflow-execution#19
   

   This both creates and checks out that branch in one command.
   The feature name should provide a (short) description of the issue.

2. Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

3. Develop the feature and push it to your local repo.

4. Create Pull Request (PR). Make sure to comment on the issue that your PR is supposed to solve.

This site is open source. Improve this page.