Changes between Version 16 and Version 17 of DRM4G/Development

Timestamp:

Dec 12, 2016 8:03:28 PM (5 years ago)

Author:

minondoa

Comment:

--

DRM4G/Development

@@ -2 +2 @@
 Contributing
 If you want to contribute to this repository please be aware that this project uses a gitflow workflow with the next release branch called next.
+* You can find the project [[https://github.com/SantanderMetGroup/DRM4G|here]].
+
 Please fork this repository and create a local branch split off of the next branch and create pull requests back to the origin next branch.
-We [try/strive/] to adopt a DevOps [development methodology/set of practices].
+
+We [try/strive/] to adopt a !DevOps [development methodology/set of practices].
 }}}
 [[TOC(heading=Development)]]
-= Development =
+
+= Contributing for users =
+
+To make it easier and more accessible for anyone to play around with the DRM4G, we have decided to host our source code on **!GitHub**.
+
+If you want to contribute to this repository please be aware that this project follows a certain [#OurGitworkflow gitflow].
+
+So please fork this repository and create a local branch in which to do your work, and then create a pull requests to the main DRM4G repository.
+
+[[br]]
+
+== Necessary Steps ==
+For those of you who wish to help but don't know how, the  first thing you need is a [[https://github.com/join?source=header-home|GitHub account]].
+
+In our project's page hit the "'''''Fork'''''" button at the top right corner:
+
+[[Image(fork_button.png)]]
+
+This will create a copy of our repository in your account where you'll develop your own feature or implement a bugfix that you may believe is necessary. You'll be submitting changes to this one until you are certain everything works properly, at which point you can request to have your changes integrated into the DRM4G's repository.
+
+To continue, you'll need to setup a local repository where you'll be changing the code and doing your testing. To do this you'll need your repository URL, that can be obtained adding '''.git''' to your project page or by clicking on the "'''''Clone or download'''''" button:
+
+
+[[Image(clone_button.png)]]
+
+
+In Linux operating systems:
+* Open a terminal on the folder in which you wish your local copy of the repository to be stored (it's recommended to use an empty folder) and run the following commands:
+
+{{{#!sh
+git init  #to initialize an empty Git repository
+git remote add origin <your_repository_url> #to make your local repository point to your remote repository in GitHub
+git fetch
+git checkout develop #to create a local copy of the develop branch
+}}} 
+
+To be consistent with our [wiki:DRM4G/Development#OurGitworkflow gitflow], all you'll be able to do is create '''feature or bugfix branches''', and you'll have to follow our naming conventions to do so.
+* Our !GitHub's default branch is "'''develop'''", and this is done intentionally, since the "'''master'''" will only be updated when publishing a new release
+ * __This means that all pull requests to the "'''master'''" branch will be rejected__
+* The naming convention will just be to create branches in lower case letters separated by underscores ("'''_'''") that describe what you're trying to accomplish with the branch.
+
+With this, you will now have DRM4G's source code at your disposal.
+
+{{{#!comment
+There are a lot of tutorials showing how to use git, including [[wiki:versionControl/git|our own]], but here is a more specific one, a simple step by step explanation on how to start using it to help us improve DRM4G.
+}}}
+
+From here you could create branches for every new feature you'd like to include to the DRM4G, for a more in depth tutorial on how to do that, click [[https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging|here]].
+
+
+[[br]]
+
+== Testing the DRM4G
+Once you've made the changes you wanted to, you'll want to install your version to be sure that your new feature is working properly.
+
+Just in case you would like to try out different versions, we recommend you use a __virtual environment__ to test it.
+
+ * [[http://pythoncentral.io/how-to-install-virtualenv-python/|Here]] you can find a tutorial on how to install a virtual environment, or you can look for one on your own.
+
+Before you can install and try out your own version, you'll have to build your own package:
+* Open a terminal in the folder where your repository is located.
+* Run the command `python setup.py sdist`
+
+This will create a a distribution package under a folder called '''dist'''.
+
+
+=== Installing your version in a virtual environment ===
+
+Go to wherever you have your virtual environment, open a terminal and execute the following commands:
+
+{{{#!sh
+source bin/activate
+export DRM4G_DIR = $PWD/conf 
+pip install path/to/drm4g/package
+}}} 
+ ^DRM4G_DIR is where the configuration files will be installed. More information [[wiki:DRM4G/Installation#OptionalEnvironmentVariables|here]].^
+
+And that's it. Now you can use and test your own version of DRM4G.[[BR]]
+
+'''''For other ways to install the DRM4G, you can check [[wiki:DRM4G/Installation|here]].'''''
+
+
+[[br]]
+
+== Commiting changes
+
+After you've tested that everything is in working order, it's time to update your !GitHub fork.
+
+{{{#!sh
+git add .
+git commit -m "Description of the changes you've made"
+git push origin develop
+}}}
+{{{#!comment
+Creo que esto ya no hace falta, al hacer el "git checkout" ya se empieza a monitorizar la rama remota
+git push -u origin develop #just the first time, the following times just run "git push origin develop"
+}}}
+
+
+From here you'll have to create a '''Pull request'''.
+
+
+[[br]]
+
+== Creating a Pull Request ==
+
+As time passes, chances are that the main DRM4G repository has had other contributors merge changes into it, so you should first update your local repository and check that there are no conflicts.
+
+{{{#!sh
+git checkout develop
+git remote add github https://github.com/SantanderMetGroup/DRM4G.git #just do run this command the first time to add the main repository to the list of your remotes
+git pull github develop
+}}}
+
+If there have been any changes, but there are no conflicts, you can just ''push'' your changes into your remote repository.
+
+{{{#!sh
+git push origin develop
+}}}
+
+In the case that there are conflicts, resolve them and commit the changes, after do the ''push'' to update your remote repository.
+
+After, you just have to go to your repositories web page and click on the "'''''New pull request'''''" button.
+
+
+[[Image(pull_request_button.png)]]
+
+A message will tell you if there are any conflicts that need to be solved or if an automatic merge is possible. Then you just have to click on the "'''''Create pull request'''''", give this merge a title (which will serve as the commit message if the pull request is accepted), a comment if you want (can be useful to explain in more detail why this should be integrated into the DRM4G), and click a second time on the "'''''Create pull request'''''" button.
+
+Now you'll have to wait and see if the administrator of the project accepts the changes you're proposing.
+
+{{{#!comment
+From your project repository
+For more information on how to use git 
+}}}
+
+----
+
+Another option would be to create a new branch from the "'''develop'''" branch and then try to make a pull request from that.
+
+{{{#!sh
+git checkout develop
+git checkout -b new_branch
+#make some changes
+git add .
+git commit -m "Description of the changes you've made"
+git push origin new_branch
+}}}
+
+The next time you enter your repository's web page, you'll see a new button:
+
+[[Image(pull_request_new_branch.png)]]
+
+Click on "'''''Compare & pull request'''''" to perform a pull request on to the main repository. The same will happen as when clicking on "New pull request" when on a previously existing branch.
+
+
+
+[[br]]
+
+[[br]]
+
+= Contributing for developers =
 The aim of this section will be to explain the process we follow to contribute to the development of the DRM4G.
 
@@ -12 +176 @@
 We use something similar to a [http://nvie.com/posts/a-successful-git-branching-model/ gitflow] workflow. Internally we synchronize our work with **!GitBucket**, which is what will be considered as the  '''''central repository''''' of the '''Santander Meteorology Group'''.
 * You can find the project [https://meteo.unican.es/gitbucket/DRM4G/DRM4G here], but to be able to access it you must first get a [https://meteo.unican.es/gitbucket/register GitBucket account] and get access to the private repository.
+* Have in mind that we try to adopt the !DevOps development methodology.
 
 [[br]]
@@ -278 +443 @@
 
 At the end, the last step is to update the [wiki:DRM4G/ChangeLog realese wiki page] and the references in the section "[wiki:DRM4G#Newreleases New releases]" of the DRM4G's main wiki page.
+
+
+
+[[br]]
+
+== Managing the !GitHub account ==
+For the administrator of the DRM4G's !GitHub repository:
+
+When you see that there's a new pull request, either because you saw it on the projects page or because you received a message in your mail informing you about it, you can click on the "'''''Pull requests'''''" button.
+
+[[Image(view_pull_requests_button.png)]]
+
+
+* If you agree with the changes made, and there are no conflicts, you can just click on the "'''''Merge pull request'''''" button.
+ * You'll automatically see a commit message that will look something like this: "__Merge pull request #X from <contributor>/<branch_name>__"
+ * Bellow that, you can write an "optional extended description". 
+  * When running `git log` from the command line, you'll just see both lines shown as the commit message.
+ * When done just click on the "'''''Confirm merge'''''" button to finish.
+* If don't agree or there are conflicts, you can click right next to the "Merge pull request" button, where it says "'''''command line instructions'''''" to perform a manual merge.
+ * Just follow the instructions shown there.
+ * Optionally, you could also try to solve the conflicts wiht the web editor, but this isn't recommended since you can't test what you're changing, unless the conflict is in a comment or a text message, not in the code.
+
+[[Image(merge_pull_request_button.png)]]