-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Updates to descriptive project files. #137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
| 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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?