mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2024-11-21 03:13:42 +08:00
Code Issues Packages Projects Releases Wiki Activity
1805ef0668
netcdf-c/CONTRIBUTING.html
Dennis Heimbigner 39e9cd0ffe Fix issues with Github pull request 187 
(https://github.com/Unidata/netcdf-c/pull/187)
Primary problem was cmake build errors.
2016-01-08 12:55:11 -07:00

249 lines
11 KiB
HTML
Raw Blame History

<html>
<body>
<img src="http://www.unidata.ucar.edu/images/logos/thredds_tds-150x150.png"/>
<h1>Welcome contributors!</h1>
First off, thank you for your interest in contributing to the THREDDS project!
This repository contains the code for both netCDF-Java and the THREDDS Data Server (TDS) projects.
The other projects held under the THREDDS umbrella are <a href="https://github.com/unidata/rosetta>Rosetta</a> and the latest addition, <a href="https://github.com/unidata/siphon>Siphon</a> (a python interface to the TDS).
<h2>Process Overview</h2>
<ul>
<li> <a href="#gh-setup">GitHub Setup</a>
<ul>
<li> <a href="#gh-join">Join Github!</a>
<li> <a href="#gh-fork">Fork the Unidata THREDDS project</a>
<li> <a href="#gh-pull-ud-thredds">Pull down local copy of the Unidata THREDDS project</a>
<li> <a href="#gh-pull-personal-thredds">Add and pull down a local copy of your THREDDS project fork</a>
</ul>
<li> <a href="#gh-contrib-workflow">Contribution workflow</a>
<ul>
<li> <a href="#gh-sync-ud">Make sure you have the latest changes from Unidata THREDDS repository</a>
<li> <a href="#gh-branch">Make a new branch for your work and start hacking</a>
<li> <a href="#gh-history-cleanup">Clean up your git commit history</a>
<li> <a href="#gh-final-commit-for-pr">Push changes to your fork to use for the pull request</a>
<li> <a href="#gh-pr">Make the pull request</a>
</ul>
<li> <a href="#gh-now-what">Now what?</a>
</ul>
</ul>
<h2><a name="gh-setup">GitHub Setup</a></h2>
<h3><a name="gh-join">Join Github!</a></h3>
To get started contributing to the THREDDS project, the first thing you should do is <a href="https://github.com/join">signup for a free account on GitHub</a>.
<h3><a name="gh-fork">Fork the Unidata THREDDS project</a></h3>
Once you have an account, go ahead and <a href="https://github.com/unidata/thredds#fork-destination-box">fork</a> the THREDDS project.
By forking the project, you will have a complete copy of the THREDDS project, history and all, under your personal account.
This will allow you to make pull requests against the Unidata THREDDS repository, which is the primairy mechanism used to add new code to the project (even Unidata developers do this!).
<h3><a name="gh-pull-ud-thredds">Pull down local copy of the Unidata THREDDS project</a></h3>
After cloning the Unidata repository, you can pull down the source code to your local machine by using git:
<pre>git clone --origin unidata git@github.com:Unidata/thredds.git (for ssh)</pre>
or
<pre>git clone --origin unidata https://github.com/Unidata/thredds.git (for http)</pre>
Note that these commands reference the Unidata repository.
<p>
Normally in git, the remote repository you clone from is automatically named 'origin'.
To help with any confusion when making pull requests, this commands above rename the remote repository to 'unidata'.
<h3><a name="gh-pull-personal-thredds">Add and pull down a local copy of your THREDDS project fork</a></h3>
Next, move into the source directory git has created, and add your personal fork of the THREDDS code as a remote"
<pre>git clone --origin me git@github.com:<my-github-user-name>/thredds.git (for ssh)</pre>
or
<pre>git clone --origin me https://github.com/,my-github-user-name>/thredds.git (for http)</pre>
Now you are all set!
<h2><a name="gh-contrib-workflow">Contribution workflow</a></h2>
<h3><a name="gh-sync-ud">Make sure you have the latest changes from Unidata THREDDS repository</a></h3>
First, make sure you have the most recent changes to the THREDDS code by using git pull:
<pre>git pull unidata master</pre>
<h3><a name="gh-branch">Make a new branch for your work and start hacking</a></h3>
Next, make a new branch where you will actually do the hacking:
<pre>git checkout -b mywork</pre>
As of this point, the branch 'mywork' is local.
To make this branch part of your personal GitHub Remote repository, use the following command:
<pre>git push -u me mywork</pre>
Now git (on your local machine) is setup to a point where you can start hacking on the code and commit changes to your personal GitHub repository.
At any point, you may add commits to your local copy of the repository by using:
<pre>git commit</pre>
If you would like these changes to be stored on your personal remote repository, simply use:
<pre>git push me mywork</pre>
Once you are satisified with your work, there is one last step to complete before submitting the pull request - clean up the history.
<h3><a name="gh-history-cleanup">Clean up your git commit history</a></h3>
Commit history can often be full of temporiariy commit messages, of commits with code changes that ultimately didn't make the final cut.
<p>
To clean up your history, use the <pre>git rebase -i</pre> command, which will open an editor:
<pre>
sarms@flip: [mywork] git rebase -i
pick 083508e first commit of my really cool feature or bug fix!
pick 9bcba01 Oops missed this one thing. This commit fixes that.
# Rebase 083508e..9bcba01 onto 083508e (2 command(s))
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit</pre>message
# x, exec = run command (the rest of the line) using shell
# d, drop = remove commit
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
<pre>
Based on my commit messages, you can see that commit </pre>1' fixed a mistake from my first commit.
It would be nice to 'squash' those changes into the first commit, so that the official history does not show my mistake..uhhh...this extra commit.
To do so, edit the text to change the second commits 'pick' to 'squash':
<pre>h
pick 083508e first commit of my really cool feature or bug fix!
squash 9bcba01 Oops missed this one thing. This commit fixes that.
# Rebase 083508e..9bcba01 onto 083508e (2 command(s))
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit</pre>message
# x, exec = run command (the rest of the line) using shell
# d, drop = remove commit
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
<pre>
Once you have marked the commits to be squashed and exited the edit, you will prompted to change the commit message for the new, squashed, mega commit:
</pre>
# This is a combination of 2 commits.
# The first commit's message is:
first commit of my really cool feature or bug fix!
# This is the 2nd commit message:
Oops missed this one thing. This commit fixes that.
#Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Date: Thu Oct 15 09:59:23 2015 -0600
#
# interactive rebase in progress; onto 083508e
# Last commands done (2 commands done):
# pick 09134d5 first commit of my really cool feature or bug fix!
# squash 9bcba01 Oops missed this one thing. This commit fixes that.
# No commands remaining.
# You are currently editing a commit while rebasing branch 'mywork' on '0835 08e'.
#
# Changes to be committed:
...
<pre>
Edit the two commit messages into a single message that describes the overall change:
</pre>
Once you have and exit, you will have a change to change the commit message for the new, squashed, mega commit:
<pre>h
Really cool feature or bug fix. Addresses the github issue Unidata/thredds#1
#Please enter the commit message for your changes. Lines starting
# with </pre>l be ignored, and an empty message aborts the commit.
#
# Date: Thu Oct 15 09:59:23 2015 -0600
#
# interactive rebase in progress; onto 083508e
# Last commands done (2 commands done):
# pick 09134d5 first commit of my really cool feature or bug fix!
# squash 9bcba01 Oops missed this one thing. This commit fixes that.
# No commands remaining.
# You are currently editing a commit while rebasing branch 'mywork' on '0835 08e'.
#
# Changes to be committed:
...
<pre>
Now, when you look at your git commit logs, you will see:
</pre>
commit 805b4723c4a2cbbed240354332cd7af57559a1b9
Author: Sean Arms <sarms@ucar.edu>
Date: Thu Oct 15 09:59:23 2015 -0600
Really cool feature or bug fix. Addresses the github issue Unidata/thredds#1
<pre>
Note that the commit conains the text </pre>a/thredds#1'.
This is a cool github trick that will allow you to reference GitHub issues within your commit messages.
When viewed on github.com, this will be turned into a hyperlink to the issue.
While not every contribution will address an issue, please use this feature if your contribution does!
<h3><a name="gh-final-commit-for-pr">Push changes to your fork to use for the pull request</a></h3>
Now that you have cleaned up the history, you will need to make a final push to your personal GitHub repository.
However, the rebase has changed the history of your local branch, which means you will need to use the '--force' flag in your push:
<pre>ush --force me mywork</pre>
<h3><a name="gh-pr">Make the pull request</a></h3>
Finally, go to your personal remote repository on github.com and switch to your 'mywork' branch.
Once you are on your work branch, you will see a button that says "Pull request", which will allow you to make a pull request.
The github pull request page will allow you to select which repository and branch you would like to submit the pull request to (the 'base fork', which should be 'Unidata/thredds', and 'base', which should be 'master'), as well as the 'head fork' and 'compare' (which should be '<github-user-name/thredds>' and 'mywork', respectivly).
Once this is setup, you can make the pull request.
<h2><a name="gh-now-what">Now what?</a></h2>
The Unidata THREDDS project is setup such that automated testing for all pull requests is done via TravisCI.
The status of the tests can be seen on the pull request page.
For example, see <a href="https://github.com/Unidata/thredds/pull/231">Unidata/thredds#231</a> by selecting the 'View Details' button.
This pull request was tested on <a href="https://travis-ci.org/Unidata/thredds/builds/84433104">TravisCI</a> and passed on all versions of Java supported by the current master branch.
We have setup the THREDDS repository such that changes that do not pass these tests cannot be merged.
One of the Unidata THREDDS team members will work with you to make sure your work is ready for merging once the tests have passed on TravisCI.
Note that as changes to your pull request may be required, you can simply push thos changes to your personal GitHub repository and the pull request will automatically be updated and new TravisCI tests will be initiated.
If your pull request addresses a bug, we kindly ask that you include a test in your pull request.
If you do not know how to write tests in Java, we will be more than happy to work with you!
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink