Skip to content

CropME contributing workflow

Jump to bottom
cyrillemidingoyi edited this page Nov 28, 2018 · 46 revisions

Contributors are invited to follow this process to interact with the project and allows an effective collaboration work.

The following steps are common to the contribution to any CropME repository and are defined from the main rules in Rob Allen’s article

Fork a CropME project repository & clone locally

You have to fork any CropME repository to obtain its copy in your github account. After accessing to CropME Github project , select one repository and just click on “Fork” button in Github. You click on “clone and download” button on your github account and copy the SSH clone URL, and you clone it by this command:

git clone SSH_Clone_URL

You change SSH_Clone_URL by the copied link.

Create an upstream remote and synchronize with your local copy

You need to synchronize the local copy with the original project to allow the update of local copy:

git remote add upstream SSH_Clone_URL

with SSH_Clone_URL the SSH Clone URL of the main repository

Create a new branch

It is recommended to create a new branch to put each part of your work. Before you create it, be sure that you have all the upstream changes (main github project) from the origin master::
git checkout master (to branch on master) git pull upstream master (to synchronize with the main project)
To create a new branch and access to it::
git checkout -b new_branch

Add a CropML DTD, a model unit, a tool, a library or any file/repository on a branch and write commit message

You select the repository in which you want to contribute. For example, if you want to update CropML DTD, you choose CropML repository and add its update:

git add modelunit.dtd

Push your branch to your origin repository

Create a new pull request

Respond to any pull request and give your feedback

pull a remote branch from a fork repository of an AMEI member

Make issues

Update the documentation

Clone this wiki locally