Skip to content

Commit

Permalink
projectmesa#144 - Fix - Some bloopers and formatting issues in docume…
Browse files Browse the repository at this point in the history
…ntation
Mizudera committed Jul 10, 2015
1 parent fc23adf commit 86c3229
Showing 2 changed files with 11 additions and 13 deletions.
14 changes: 6 additions & 8 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -11,18 +11,18 @@ In no particular order, examples include:
- 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`_.
No contribution is too small. Although, contributions can be too 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
- 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
- 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
@@ -36,16 +36,14 @@ 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 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.
- Your changes don't break the models or 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.
- New features are demonstrated in a model, so folks can understand more easily.


Licensing
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -9,13 +9,13 @@ Mesa: Agent-based modeling in Python 3+

`Mesa`_ is an Apache2 licensed agent-based modeling (or ABM) framework in Python.

It allows users to quickly create agent-based models using built-in core components (such as spatial grids and agent schedulers) or customized implementations; visualize them using a browser-based interface; and analyze their results using Python's data analysis tools. It's goal is to be the Python 3-based alternative to NetLogo, Repast, or MASON.
It allows users to quickly create agent-based models using built-in core components (such as spatial grids and agent schedulers) or customized implementations; visualize them using a browser-based interface; and analyze their results using Python's data analysis tools. Its goal is to be the Python 3-based alternative to NetLogo, Repast, or MASON.


.. image:: https://cloud.githubusercontent.com/assets/166734/8611697/ce61ad08-268a-11e5-880b-4776dd738e0e.png
:width: 100%
:scale: 100%
:alt: A screenshot of the Shelling Model in Mesa
:alt: A screenshot of the Schelling Model in Mesa

*Above: A Mesa implementation of the Schelling segregation model,
being visualized in a browser window and analyzed in an IPython
@@ -27,7 +27,7 @@ notebook.*
Features
------------

* Modular compoments
* Modular components
* Browser-based visualization
* Built-in tools for analysis

@@ -40,7 +40,7 @@ Getting started quickly:
$ pip install mesa
For more help on using Mesa, checkout the following resources:
For more help on using Mesa, check out the following resources:

* `Intro to Mesa Tutorial`_
* `Docs`_
@@ -55,7 +55,7 @@ For more help on using Mesa, checkout the following resources:
Contributing back to Mesa
----------------------------

If you run into an issues, please file a `ticket`_ for us to discuss. If possible, follow up with a pull request.
If you run into an issue, please file a `ticket`_ for us to discuss. If possible, follow up with a pull request.

If you would like to add a feature, please reach out via `ticket`_ or the `email list`_ for discussion. A feature is most likely to be added if you build it!

0 comments on commit 86c3229

Please sign in to comment.