Difference between revisions of "Portal:Contribute"
From MNE-CPP Wiki
| Line 1: | Line 1: | ||
This portal features information on how the code contribution process works in the MNE-CPP project. | This portal features information on how the code contribution process works in the MNE-CPP project. | ||
| + | == The MNE-CPP Contribution Cycle == | ||
| − | = | + | === How to contribute your code === |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | == How to contribute your code == | + | |
| − | + | ||
This guide will show you how to contribute your own code to the MNE-CPP project: | This guide will show you how to contribute your own code to the MNE-CPP project: | ||
# If you have not already done so, fork the repository to your own Git Hub repository. | # If you have not already done so, fork the repository to your own Git Hub repository. | ||
| − | # Clone your remote (Git Hub) repository to your local system. | + | # Clone your remote (forked Git Hub) repository to your local system. |
# Make your changes to the code (please follow the [[Coding Conventions & Style|coding conventions]]) and do a commit (please follow the [[Commit Policy|commit policy]]). | # Make your changes to the code (please follow the [[Coding Conventions & Style|coding conventions]]) and do a commit (please follow the [[Commit Policy|commit policy]]). | ||
# Push your changes to your remote (Git Hub) repository. | # Push your changes to your remote (Git Hub) repository. | ||
| − | # Go to your remote repository via the GitHub website and create a pull request. | + | # Go to your remote (forked Git Hub) repository via the GitHub website and create a pull request: |
| + | ## Right next to the branch selection tool, look for the ''New pull request'' button. | ||
| + | ## The Compare Changes page will appear. | ||
| + | ## Select the appropriate ''base'' and ''compare'' branch (by default the ''base'' branch should be the branch of the repository you forked from). The ''base'' branch is the branch of the repository you want to merge your changes to (MNE-CPP main repository). The ''compare'' branch is the branch where you implemented the new feature, bugfix, etc. | ||
| + | ## Name the pull reqest, describe your changes and hit ''Create pull request''. | ||
# After you created the pull request, wait for the peer review to be finished: | # After you created the pull request, wait for the peer review to be finished: | ||
| − | ## Two | + | ## Two MNE-CPP developers will review your code. |
| − | ## Please change your code on your local | + | ## Please change your code on your local machine based on the comments made by the reviewers. Note: There is no need to create a new pull request for every new change you make to your code. Just commit the changes and push your code to your repository. The changes will automatically be added to your already created pull request. |
| − | + | ||
## As soon as your code suits the mne-cpp coding guidelines and all tests were successfull, the code will be merged into the main mne-cpp repository. | ## As soon as your code suits the mne-cpp coding guidelines and all tests were successfull, the code will be merged into the main mne-cpp repository. | ||
| − | # Congratulations! | + | # Congratulations! You are now an official contributor to the MNE-CPP project. Keep up the good work! |
Revision as of 13:59, 6 January 2016
This portal features information on how the code contribution process works in the MNE-CPP project.
The MNE-CPP Contribution Cycle
How to contribute your code
This guide will show you how to contribute your own code to the MNE-CPP project:
- If you have not already done so, fork the repository to your own Git Hub repository.
- Clone your remote (forked Git Hub) repository to your local system.
- Make your changes to the code (please follow the coding conventions) and do a commit (please follow the commit policy).
- Push your changes to your remote (Git Hub) repository.
- Go to your remote (forked Git Hub) repository via the GitHub website and create a pull request:
- Right next to the branch selection tool, look for the New pull request button.
- The Compare Changes page will appear.
- Select the appropriate base and compare branch (by default the base branch should be the branch of the repository you forked from). The base branch is the branch of the repository you want to merge your changes to (MNE-CPP main repository). The compare branch is the branch where you implemented the new feature, bugfix, etc.
- Name the pull reqest, describe your changes and hit Create pull request.
- After you created the pull request, wait for the peer review to be finished:
- Two MNE-CPP developers will review your code.
- Please change your code on your local machine based on the comments made by the reviewers. Note: There is no need to create a new pull request for every new change you make to your code. Just commit the changes and push your code to your repository. The changes will automatically be added to your already created pull request.
- As soon as your code suits the mne-cpp coding guidelines and all tests were successfull, the code will be merged into the main mne-cpp repository.
- Congratulations! You are now an official contributor to the MNE-CPP project. Keep up the good work!
