Updates to descriptive project files.

[jackiekazil]

This pull request does the following...

• Combines original CHANGES.md with HISTORY.rst -- I was an idiot and had 2 files running that did the same time.
• Changes CONTRIBUTING.md to CONTRIBUTING.rst
• Changes LICENSE.md to LICENSE.rst

The change to .rst makes doc integration easier and seems to be more or a Python standard than .md.

[jackiekazil]

@dmasad --- Can you give this a review and merge to master? After this is merged into master, for #136, I am going to ask that you update with these changes, then add a line or two to History.rst.

[jackiekazil]

Also... README is not included in this, because I am working on that in another branch. I wanted to push this through so it wouldn't hold up #136

[jackiekazil]

So, I realized that I have errors. I am going to take this back for about 10 minutes-20 minutes and fix those. When I reassign to you, it means it is ready for reals.

[dmasad]

Can you squash the commits on this and resubmit?

[dmasad]

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

[jackiekazil]

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.

[jackiekazil]

@dmasad good call on the squash. :-).... let me know what you were thinking specifically for the test and I will update. The squash is done.

[dmasad]

How about something like this:
"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 that your changes pass the current tests and don't break the models (or edit the model code to comply with your changes). If you're contributing new features, we encourage you to also submit unit tests and/or new models that test and demonstrate those features."

[jackiekazil]

Ah... okay. Now, I see what you were looking for. I made a couple of updates to your text to make it easier to scan / break it up. Does what is below work for you? (Let me know if you want updates to my updates and I will add them.)

---

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.

[dmasad]

Looks good!

On Sun, Jul 5, 2015 at 6:33 PM Jackie Kazil [email protected]
wrote:

Ah... okay. Now, I see what you were looking for. I made a couple of
updates to your text to make it easier to scan / break it up. Does what is
below work for you? (Let me know if you want updates to my updates and I

will add them.)

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.

—
Reply to this email directly or view it on GitHub
#137 (comment).

[jackiekazil]

Pending tests, this is ready to go. .... pending tests.... hahahaha... these are all text updates, so the tests shouldn't be failing.