Skip to content

Commit 2378fcc

Browse files
committed
Addressed review comments
1 parent ebbcc8d commit 2378fcc

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ tab](https://github.com/UV-CDAT/uvcdat/issues) and start looking through
1313
interesting issues.
1414

1515
Feel free to ask questions on [mailing
16-
list](uvcdat-users@llnl.gov)
16+
list](uvcdat-users@llnl.gov) or [askbot](http://askbot-uvcdat.llnl.gov/questions)
1717

1818
Bug Reports/Enhancement Requests
1919
--------------------------------
@@ -140,13 +140,8 @@ Contributing to the code base
140140
-----------------------------
141141
### Code Standards
142142

143-
*UV-CDAT* uses the [PEP8](http://www.python.org/dev/peps/pep-0008/)
144-
standard. There are several tools to ensure you abide by this standard.
145-
146-
Alternatively, use [flake8](http://pypi.python.org/pypi/flake8) tool for
147-
checking the style of your code. Additional standards are outlined on
148-
the [code style wiki
149-
page](LINK HERE).
143+
*UV-CDAT* uses [flake8](http://pypi.python.org/pypi/flake8) tool for
144+
checking the style of your code.
150145

151146
Please try to maintain backward-compatibility. *UV-CDAT* has lots of
152147
users with lots of existing code, so don't break it if at all possible.
@@ -175,6 +170,8 @@ All tests should go into the *tests* subdirectory of the specific
175170
package. There are probably many examples already there and looking to
176171
these for inspiration is suggested.
177172

173+
#### Regression testing
174+
178175
The `testing.checkimage.py` module has special `check_result_image` function
179176
that make it easier to check whether plot produced after data extraction and
180177
transformation are equivalent to baseline. For an example see below:
@@ -202,7 +199,7 @@ transformation are equivalent to baseline. For an example see below:
202199

203200
#### Running the test suite
204201

205-
The tests can then be run directly inside your build tree by typing::
202+
The tests can then be run directly inside your build tree (directory) by typing::
206203

207204
ctest
208205

@@ -218,14 +215,6 @@ constructs:
218215
ctest -R test-name
219216
ctest -R regex*
220217

221-
#### Running the performance test suite
222-
223-
TODO
224-
225-
### Documenting your code
226-
227-
TODO
228-
229218
Contributing your changes to *UV-CDAT*
230219
-------------------------------------
231220

@@ -348,7 +337,7 @@ automatically updated. Pushing them to GitHub again is done by:
348337
This will automatically update your Pull Request with the latest code
349338
and restart the Travis-CI tests.
350339

351-
### Delete your merged branch (optional)
340+
### Delete your merged branch from your fork (optional)
352341

353342
Once your feature branch is accepted into upstream, you'll probably want
354343
to get rid of the branch. First, merge upstream master into your branch

0 commit comments

Comments
 (0)