Difference between revisions of "Portal:Contribute"
From MNE-CPP Wiki
| Line 1: | Line 1: | ||
| − | + | This portal features information on how the code contribution process work in the MNE-CPP project. | |
| + | |||
| + | == Project Management == | ||
The MNE-CPP project is maintained by an agile management approach, using JIRA. JIRA is a well known issue tracking tool by Atlassian, which let's you post bug reports, improvement tasks, wishes for new features and much more. It gives you a way to directly participate in the development of MNE-CPP. Please go to [https://mne-cpp.atlassian.net MNE-CPP's JIRA website] and sign up for an account if you wish to help to improve MNE-CPP. | The MNE-CPP project is maintained by an agile management approach, using JIRA. JIRA is a well known issue tracking tool by Atlassian, which let's you post bug reports, improvement tasks, wishes for new features and much more. It gives you a way to directly participate in the development of MNE-CPP. Please go to [https://mne-cpp.atlassian.net MNE-CPP's JIRA website] and sign up for an account if you wish to help to improve MNE-CPP. | ||
| Line 5: | Line 7: | ||
Next to JIRA we also use Atlassian's Confluence to share documents, meeting notes and other project related files. You can find our confluence page [https://mne-cpp.atlassian.net/wiki/ here]. | Next to JIRA we also use Atlassian's Confluence to share documents, meeting notes and other project related files. You can find our confluence page [https://mne-cpp.atlassian.net/wiki/ here]. | ||
| − | + | == 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: | ||
Revision as of 10:38, 5 January 2016
This portal features information on how the code contribution process work in the MNE-CPP project.
Project Management
The MNE-CPP project is maintained by an agile management approach, using JIRA. JIRA is a well known issue tracking tool by Atlassian, which let's you post bug reports, improvement tasks, wishes for new features and much more. It gives you a way to directly participate in the development of MNE-CPP. Please go to MNE-CPP's JIRA website and sign up for an account if you wish to help to improve MNE-CPP.
Next to JIRA we also use Atlassian's Confluence to share documents, meeting notes and other project related files. You can find our confluence page here.
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 (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 repository via the GitHub website and create a pull request.
- After you created the pull request, wait for the peer review to be finished:
- Two full developers will review your code.
- Please change your code on your local machines based on the comments made by the reviewers.
- 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 create 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! Your now an official contributor to the MNE-CPP project. Keep up the good work!
