Skip to content

Commit ed391b8

Browse files
committed
Added reference to contributing from readme
1 parent 08bc2bb commit ed391b8

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ local repository and GitHub.
8787
You may want to fork UV-CDAT to work on the code if you have access to the repository,
8888
then just create a branch there instead. If you don't then follow these guidelines
8989
for forking UV-CDAT. Go to the [UV-CDAT project page](https://github.com/UV-CDAT/uvcdat)
90-
and hit the *fork* button. You will want to clone your fork to your machine:
90+
and hit the *fork* button. You will want to clone your fork to your machine: (HTTPS
91+
or SSH is preferred to git:// for security reasons).
9192

9293
git clone git://github.com/UV-CDAT/uvcdat.git UV-CDAT-yourname
9394
cd UV-CDAT-yourname
@@ -96,10 +97,9 @@ and hit the *fork* button. You will want to clone your fork to your machine:
9697
This creates the directory UV-CDAT-yourname and connects your repository
9798
to the upstream (main project) *UV-CDAT* repository.
9899

99-
You will also need to hook up Travis-CI to your GitHub repository so the
100-
suite is automatically run when a Pull Request is submitted.
101-
Instructions are
102-
[here](http://about.travis-ci.org/docs/user/getting-started/).
100+
You will also need to hook up Travis-CI to your GitHub (if you have forked)
101+
repository so the suite is automatically run when a Pull Request is submitted.
102+
Instructions are [here](http://about.travis-ci.org/docs/user/getting-started/).
103103

104104
### Creating a Branch
105105

@@ -128,9 +128,6 @@ using default settings:
128128
cmake uvcdat-path-to-source
129129
make -jN
130130

131-
If you startup the Python interpreter in the *UV-CDAT* source
132-
directory you will call the built C extensions
133-
134131
Contributing to the documentation
135132
---------------------------------
136133

@@ -266,13 +263,15 @@ The following defines how a commit message should be structured. Please
266263
reference the relevant GitHub issues in your commit message using GH1234
267264
or \#1234. Either style is fine, but the former is generally preferred:
268265

269-
> - a subject line with \< 80 chars.
266+
> - a subject line with \< 80 chars (50-char subject, 72-char rest).
270267
> - One blank line.
271-
> - Optionally, a commit message body.
268+
> - Optionally, a commit message body (72-char).
272269
273270
Now you can commit your changes in your local repository:
274271

275-
git commit -m
272+
git commit -a
273+
or
274+
git commit -a -m "Message..Here"
276275

277276
If you have multiple commits, it is common to want to combine them into
278277
one commit, often referred to as "squashing" or "rebasing". This is a

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,9 @@ uvcdat
99
Developed by partnering with ESGF and the community to create a larger problem-solving environment, UV-CDAT is an open source, easy-to-use application that links together disparate software subsystems and packages to form an integrated environment for analysis and visualization. This project seeks to advance climate science by fulfilling computational and diagnostic/visualization capabilities needed for DOE's climate research.
1010

1111
Led by Lawrence Livermore National Laboratory (LLNL), the consortium consists of four DOE laboratories (Los Alamos, Lawrence Berkeley, LLNL, and Oak Ridge), two universities (University of Utah and the Polytechnic Institute of New York University), NASA, and two private companies (Kitware and tech-X) that will develop reusable software and workflow analysis and visualization applications for large-scale DOE climate modeling and measurements archives. The UV-CDAT concept is simple and flexible enough to interchange parts to expand for future DOE activities.
12+
13+
Developing and Contributing
14+
------
15+
We'd love to get contributions from you! Please take a look at the
16+
[Contribution Documents](CONTRIBUTING.md) to see how to get your changes merged
17+
in.

0 commit comments

Comments
 (0)