Skip to content

Commit

Permalink
Update the README and CHANGELOG. Add CONTRIBUTING file.
Browse files Browse the repository at this point in the history
  • Loading branch information
peloton committed Jul 17, 2017
1 parent dd81385 commit 0e7ce0c
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 6 deletions.
12 changes: 8 additions & 4 deletions CHANGELOG.md → CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# v0.3.0
v0.3.1
=============
* Current version
* Add systematic module, with routine to simulate detector crosstalk.
* Fix bugs in the detector/SQUID labeling (instrument module).


# v0.2.0
v0.2.0
=============
* Add Fortran scripts and Makefile for the compilation.
* Add detector pointing and TOD modules.
* Doc contains end-to-end example (without systematic effect).
* Fix many bugs related to absolute imports (py 2 vs 3) and failed tests in doctest.

# v0.1.0
v0.1.0
=============
* First version of the repo (public)
* Add instrument and scanning strategy modules.
* Release public version.
19 changes: 19 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
================
Contributing to S4CMB
================

Issues
=============
Feel free to submit issues and enhancement requests.

Contributing
=============
In general, we appreciate the "fork-and-pull" Git workflow.

* Fork the repo on GitHub
* Clone the project to your own machine and set up a new branch
* Commit changes to your branch
* Push your work back up to your fork
* Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Just add in your bashrc:
::

s4cmbPATH=/path/to/the/package
export PYTHONPATH=$PYTHONPATH:$s4cmbPATH:$s4cmbPATH/instrument
export PYTHONPATH=$PYTHONPATH:$s4cmbPATH

Examples
=============
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def configuration(parent_package='', top_path=None):

setup(
name='s4cmb',
version='0.3.0',
version='0.3.1',
url='https://github.com/JulienPeloton/s4cmb',
download_url='',
license='GPL-3.0',
Expand Down

0 comments on commit 0e7ce0c

Please sign in to comment.