Portal:Contribute - Revision history

LorenzE at 22:33, 15 May 2019

2019-05-15T22:33:03Z

LorenzE at 13:42, 6 January 2016

2016-01-06T13:42:27Z

LorenzE at 13:40, 6 January 2016

2016-01-06T13:40:18Z

LorenzE at 13:31, 6 January 2016

2016-01-06T13:31:06Z

LorenzE at 13:06, 6 January 2016

2016-01-06T13:06:06Z

LorenzE at 13:05, 6 January 2016

2016-01-06T13:05:37Z

LorenzE at 13:01, 6 January 2016

2016-01-06T13:01:12Z

LorenzE at 12:59, 6 January 2016

2016-01-06T12:59:10Z

LorenzE at 12:36, 6 January 2016

2016-01-06T12:36:19Z

LorenzE at 09:38, 5 January 2016

2016-01-05T09:38:36Z

@@ Line 7: / Line 7: @@
 # If you have not already done so, fork the repository to your own Git Hub repository (see step 1 of the [[Get the MNE-CPP source code|getting the MNE-CPP source code guide]]).
 # If you have not already done so, clone your remote (forked Git Hub) repository to your local machine (see step 3 of the [[Get the MNE-CPP source code|getting the MNE-CPP source code guide]]).
-# 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]]).
+# Create a new branch and 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 (forked Git Hub) repository.
 # Go to your remote (forked Git Hub) repository via the GitHub website and create a pull request:

@@ Line 6: / Line 6: @@
 # If you have not already done so, fork the repository to your own Git Hub repository (see step 1 of the [[Get the MNE-CPP source code|getting the MNE-CPP source code guide]]).
-# Clone your remote (forked Git Hub) repository to your local machine.
+# If you have not already done so, clone your remote (forked Git Hub) repository to your local machine (see step 3 of the [[Get the MNE-CPP source code|getting the MNE-CPP source code guide]]).
 # 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 (forked Git Hub) repository.

@@ Line 5: / Line 5: @@
 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 (see step 1 of the [[Get the MNE-CPP source code|getting the MNE-CPP source code guide]]).
 # Clone your remote (forked Git Hub) repository to your local machine.
 # 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]]).

@@ Line 6: / Line 6: @@
 # 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.
+# Clone your remote (forked Git Hub) repository to your local machine.
 # 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 (forked Git Hub) repository.

@@ Line 17: / Line 17: @@
 ## 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 remote (forked Git Hub) repository. The changes will automatically be added to your already created pull request.
-## As soon as your code suits all of the MNE-CPP coding guidelines and possible inconsistencies were dealt with, your code will be merged into the main MNE-CPP repository.
+## As soon as your code suits all of the MNE-CPP coding conventions and possible inconsistencies were dealt with, your 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!

@@ Line 10: / Line 10: @@
 # 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.
+## Right next to the branch selection tool, look for the ''New pull request'' button and click it.
-## The Compare Changes page will appear.
+## 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.
+## Select the appropriate ''base'' and ''compare'' branch . The ''base'' branch is the branch of the repository you want to merge your changes to (by default the ''base'' branch is a branch of the repository you forked from). The ''compare'' branch is the branch where you implemented the new feature(s), bugfix(es), etc.
-## Name the pull reqest, describe your changes and hit ''Create pull request''.
+## Name the pull reqest, describe your changes and hit ''Create pull request'' button.
-# 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 process 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!

@@ Line 1: / Line 1: @@
 This portal features information on how the code contribution process works in the MNE-CPP project.
-== Project Management ==
+=== How to contribute your code ===
-−
-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.
-−
-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:
 # 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]]).
 # 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:
 # After you created the pull request, wait for the peer review to be finished:
-## Two full developers will review your code.
+## Two MNE-CPP developers will review your code.
-## Please change your code on your local machines based on the comments made by the reviewers.
+## 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.
-## 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!
+# Congratulations! You are now an official contributor to the MNE-CPP project. Keep up the good work!

← Older revision		Revision as of 12:36, 6 January 2016
Line 1:		Line 1:
−	This portal features information on how the code contribution process ~~work~~ in the MNE-CPP project.	+	This portal features information on how the code contribution process works in the MNE-CPP project.

	== Project Management ==		== Project Management ==