Difference between revisions of "HICN/Contribute"

From fd.io
Jump to: navigation, search
(Created page with " The hicn-stack repository is available from gerrit: git clone https://gerrit.fd.io/r/hicn There is a mirror on github: git clone https://github.com/FDio/hicn.git It is poss...")
 
Line 1: Line 1:
 +
== For developers ==
  
 
The hicn-stack repository is available from gerrit:
 
The hicn-stack repository is available from gerrit:
 +
<pre>
 
git clone https://gerrit.fd.io/r/hicn
 
git clone https://gerrit.fd.io/r/hicn
 +
</pre>
  
 
There is a mirror on github:
 
There is a mirror on github:
 +
<pre>
 
git clone https://github.com/FDio/hicn.git
 
git clone https://github.com/FDio/hicn.git
 +
</pre>
  
 
It is possible to submit a patch with the following steps:
 
It is possible to submit a patch with the following steps:
  
*1. open an issue on fd.io Jira and take the issue number
+
*1 open an issue on [https://jira.fd.io/projects/HICN  fd.io Jira] and take the issue number
*2. create a new branch with the command
+
*2 create a new branch with the command <pre>git checkout -b <jira issue number></pre>
git checkout -b <jira issue number>
+
*3 add to the modified files to the patch with <pre>git add -u</pre> if there are not new files, or <pre>git add <list new files></pre> if there are new files
*3. add to the modified files to the patch with
+
*4 commit the patch with <pre>git commit -s</pre> and put a comment with the issue number taken from [https://jira.fd.io/projects/HICN  fd.io Jira]
git add -u
+
*5 push the patch on [https://gerrit.fd.io gerrit] for the review with <pre>git review</pre>
if there are not new files, or
+
*6 add a reviewer on [https://gerrit.fd.io gerrit] code review page.
git add <list new files>
+
if there are new files
+
*4. commit the patch with
+
git commit -s
+
and put a comment with the issue number taken from fd.io Jira
+
*5. push the patch on gerrit for the review with
+
git review
+
*6. add a reviewer on gerrit code review page.
+
  
 
If a modification of non merged patch is needed, it is possible to resubmit the patch with:
 
If a modification of non merged patch is needed, it is possible to resubmit the patch with:
 +
*1 add to the modified files to the patch with <pre>git add -u</pre>
 +
*2 modify the commit of the new patch with <pre>git commit -s --amend</pre>
 +
*3 push the patch on gerrit for the review with <pre>git review</pre>
  
1 add to the modified files to the patch with
+
An account on [https://identity.linuxfoundation.org/  Linux Foundation] is necessary.
git add -u
+
2 modify the commit of the new patch with
+
git commit -s --amend
+
3 push the patch on gerrit for the review with
+
git review
+
An account on Linux Foundation is necessary.
+
  
 
If you do not want your patch to be merged, append DO_NOT_MERGE to the Jira issue ID.
 
If you do not want your patch to be merged, append DO_NOT_MERGE to the Jira issue ID.
  
  
Other resources related to the hICN project can be found at github icn-team
+
Other resources related to the hICN project can be found at [https://github.com/icn-team github icn-team]
  
 
It is possible to submit a patch with the following steps:
 
It is possible to submit a patch with the following steps:
  
1 open an issue on fd.io Jira and take the issue number
+
*1 open an issue on [https://jira.fd.io/projects/HICN  fd.io Jira] and take the issue number
2 go to the icn-team github repository and fork it
+
*2 go to the icn-team github repository and fork it
3 clone on your pc the forked project with
+
*3 clone on your pc the forked project with <pre>git clone https://github.com/<account name>/<project name>.git</pre>
git clone https://github.com/<account name>/<project name>.git
+
*4 enter in the folder of the cloned project and create a branch with
4 enter in the folder of the cloned project and create a branch with
+
<pre>
 
cd <project name>
 
cd <project name>
 
git checkout -b <new-branch-name>
 
git checkout -b <new-branch-name>
5 modify the code and push the modification with
+
</pre>
 +
*5 modify the code and push the modification with
 +
<pre>
 
git commit -am "<message>"
 
git commit -am "<message>"
 
git push origin <new-branch-name>
 
git push origin <new-branch-name>
6 go to the icn-team github project page and click on pull request and after on New pull request and after on compare across forks and select as head repository the branch on your personal github account.
+
</pre>
7 click on Create new pull request, leave an exhaustive comment, the link to the fd.io Jira issue and click on Create pull request
+
*6 go to the icn-team github project page and click on '''pull request''' and after on '''New pull request''' and after on '''compare across forks''' and select as head repository the branch on your personal github account.
 +
*7 click on '''Create new pull request''', leave an exhaustive comment, the link to the [https://jira.fd.io/projects/HICN  fd.io Jira issue] and click on '''Create pull request'''
  
hICN Kanban boards (Must have a Linux Foundation account).
+
 
 +
[https://jira.fd.io/secure/Dashboard.jspa?selectPageId=10900  hICN Kanban boards] (Must have a Linux Foundation account).

Revision as of 09:16, 26 September 2019

For developers

The hicn-stack repository is available from gerrit:

git clone https://gerrit.fd.io/r/hicn

There is a mirror on github:

git clone https://github.com/FDio/hicn.git

It is possible to submit a patch with the following steps:

  • 1 open an issue on fd.io Jira and take the issue number
  • 2 create a new branch with the command
    git checkout -b <jira issue number>
  • 3 add to the modified files to the patch with
    git add -u
    if there are not new files, or
    git add <list new files>
    if there are new files
  • 4 commit the patch with
    git commit -s
    and put a comment with the issue number taken from fd.io Jira
  • 5 push the patch on gerrit for the review with
    git review
  • 6 add a reviewer on gerrit code review page.

If a modification of non merged patch is needed, it is possible to resubmit the patch with:

  • 1 add to the modified files to the patch with
    git add -u
  • 2 modify the commit of the new patch with
    git commit -s --amend
  • 3 push the patch on gerrit for the review with
    git review

An account on Linux Foundation is necessary.

If you do not want your patch to be merged, append DO_NOT_MERGE to the Jira issue ID.


Other resources related to the hICN project can be found at github icn-team

It is possible to submit a patch with the following steps:

  • 1 open an issue on fd.io Jira and take the issue number
  • 2 go to the icn-team github repository and fork it
  • 3 clone on your pc the forked project with
    git clone https://github.com/<account name>/<project name>.git
  • 4 enter in the folder of the cloned project and create a branch with
cd <project name>
git checkout -b <new-branch-name>
  • 5 modify the code and push the modification with
git commit -am "<message>"
git push origin <new-branch-name>
  • 6 go to the icn-team github project page and click on pull request and after on New pull request and after on compare across forks and select as head repository the branch on your personal github account.
  • 7 click on Create new pull request, leave an exhaustive comment, the link to the fd.io Jira issue and click on Create pull request


hICN Kanban boards (Must have a Linux Foundation account).