Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions CHANGES.md

This file was deleted.

40 changes: 0 additions & 40 deletions CONTRIBUTING.md

This file was deleted.

72 changes: 72 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Contributing
=========================

As an open source project, Mesa welcomes contributions of many forms.

In no particular order, examples include:

- Code patches
- Bug reports and patch reviews
- New features
- Documentation improvements
- Tutorials

No contribution is too small. Although, contributions can be to big, so let's discuss via the `email list`_ OR `an issue`_.

**To submit a contribution**

- Create a ticket for the item that you are working on.
- Fork the Mesa repository
- Create a new branch if you aren't contributing to an existing branch.
- Edit the code.
- Use `PEP8`_ and the `Google Style Guide`_ as the coding standards for Python.
- If implementing a new feature, include some documentation and ideally a working example or unit test as well.
- Submit as pull requests
- Describe the change w/ ticket number(s) that the code fixes

.. _`email list` : https://groups.google.com/forum/#!forum/projectmesa
.. _`an issue` : https://github.com/projectmesa/mesa/issues
.. _`PEP8` : https://www.python.org/dev/peps/pep-0008
.. _`Google Style Guide` : https://google-styleguide.googlecode.com/svn/trunk/pyguide.html


Testing
--------

.. image:: https://coveralls.io/repos/projectmesa/mesa/badge.svg
:target: https://coveralls.io/r/projectmesa/mesa

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have some tests now; probably should mention them here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that was already captured in the text. I don't want to oversell folks on our tests, because we are still lacking quite a bit.

Can you suggest a specific edit to the following?

Testing
--------

.. image:: https://coveralls.io/repos/projectmesa/mesa/badge.svg
    :target: https://coveralls.io/r/projectmesa/mesa

We are continually working to improve our testing. At the moment, we've been testing features by implementing them in simple models. This is useful since it also expands the library of sample models.

We are continually working to improve our testing. At the moment, we've been testing features by implementing them in simple models. This is useful since it also expands the library of sample models.

We are continually working to improve our testing. At the moment, we've been testing features by implementing them in simple models. This is useful since it also expands the library of sample models. We also have several traditional unit tests in the tests/ folder.

If you're changing previous Mesa features, please make sure of the following:

- Your changes pass the current tests.
- Your changes don't break the models or that your changes include updated models.
- Additional features or rewrites of current features are accompanied by tests.
- New features are demostrated in a model, so folks can understand more easily.


Licensing
--------

The License of this project is located in `LICENSE`_. By submitting a contribution to this project, you are agreeing that your contributions under this license and
with this waiver of copyright interest.

.. _`LICENSE` : https://github.com/projectmesa/mesa/blob/master/LICENSE


Special Thanks
--------

A special thanks to the following projects who offered inspiration for this contributing file.

- `Django`_
- `18F's FOIA`_
- `18F's Midas`_

.. _`Django` : https://github.com/django/django/blob/master/CONTRIBUTING.rst
.. _`18F's FOIA` : https://github.com/18F/foia-hub/blob/master/CONTRIBUTING.md
.. _`18F's Midas` : https://github.com/18F/midas/blob/devel/CONTRIBUTING.md

35 changes: 32 additions & 3 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ Release History
Next release
++++++++++++++++++

* (Add changes here)
* (Add changes here - preceed w/ 'Bug Fix or Improvement')

0.6.1 (2015-06-27)
++++++++++++++++++

* Bug Fix: Order of operations reversed: agent is removed first and then it is placed.
* Improvement: License was updates from MIT to Apache 2.0.
* Improvement: `LICENSE`_ was updates from MIT to Apache 2.0.

.. _`LICENSE` : https://github.com/projectmesa/mesa/blob/master/LICENSE


0.6.0 (2015-06-21)
++++++++++++++++++
Expand All @@ -22,4 +25,30 @@ Next release
Pre 0.6.0
++++++++++++++++++

Code that is pre-0.6.0 is very unstable. Changes were not documented.
Code that is pre-0.6.0 is very unstable.

Our inital release was 0.5.0 (2014-11).

It included code for placing agents on a grid; a data collector and batch runner; and a front-end visualization using HTML 5 and JavaScript.

**General**

* Objects create -- Agent, Time, Space
* Project moved to Python 3
* Tornado server setup

**Front-end**

* Front-end grid implemented
* ASCII visualization implemented

**Examples models**

* Forest Fire
* Schelling
* Wolf-Sheep Predation

**0.1.0 (2014-09-19)**

* A conversation
* Birth
File renamed without changes.