Skip to content

Commit

Permalink
feat: improve GitHub support (#159)
Browse files Browse the repository at this point in the history
* Add Gitter badge
* Fix contributing link
  • Loading branch information
Midnighter committed Aug 12, 2017
1 parent 81e30d1 commit a5f7125
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 23 deletions.
31 changes: 22 additions & 9 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
* Operating System:
* Python version:
* memote version:
#### Problem description

### Description
Please explain:
* **what** you tried to achieve,
* **how** you went about it (referring to the code sample), and
* **why** the current behaviour is a problem and what output
you expected instead.

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.
#### Code Sample

### What I Did
Create a [minimal, complete, verifiable example
](https://stackoverflow.com/help/mcve).

```python
# Paste your code here or link to a gist.
```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.

```bash
# If there was a crash, please include the traceback here.
```

### Context

<details>
* Operating System:
* Python version:
* memote version:
</details>
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* [ ] fix #x (issue number)
* [ ] description of feature/fix
* [ ] tests added/passed
* [ ] add an entry to the [next release](../HISTORY.rst)
7 changes: 7 additions & 0 deletions .github/SUPPORT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
=======
Support
=======

* memote `mailing list <https://groups.google.com/forum/#!forum/memote>`_
* memote `gitter chat <https://gitter.im/opencobra/memote>`_

30 changes: 16 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ memote - the genome-scale metabolic model test suite
:target: https://memote.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/opencobra/memote/shield.svg
:target: https://pyup.io/repos/github/opencobra/memote/
:alt: Updates

.. image:: https://codecov.io/gh/opencobra/memote/branch/master/graph/badge.svg
:target: https://codecov.io/gh/opencobra/memote
:alt: Coverage

.. image:: https://badges.gitter.im/opencobra/memote.svg
:target: https://gitter.im/opencobra/memote
:alt: Gitter

.. summary-start
Our goal in promoting this tool is to achieve two major shifts in the metabolic
Expand All @@ -44,9 +44,9 @@ The `memote` tool therefore performs four subfunctions:

And in order to make this process as easy as possible the generated repository
can easily be integrated with continuous integration testing providers such as
Travis CI, which means that anytime you push a
model change to GitHub, the test suite will be run automatically and a report
will be available for you to look at via GitHub pages for your repository.
Travis CI, which means that anytime you push a model change to GitHub, the test
suite will be run automatically and a report will be available for you to look
at via GitHub pages for your repository.

.. summary-end
Expand All @@ -63,7 +63,8 @@ To install memote, run this command in your terminal:
$ pip install memote
This is the preferred method to install memote, as it will always install the most recent stable release.
This is the preferred method to install memote, as it will always install the
most recent stable release.

.. who-start
Expand All @@ -73,17 +74,17 @@ Contact
For comments and questions get in touch via

* our `gitter chatroom <https://gitter.im/opencobra/memote>`_
* or using the `GitHub issues <https://github.com/opencobra/memote/issues>`_.
* or our `mailing list <https://groups.google.com/forum/#!forum/memote>`_.

Are you excited about this project? Consider `contributing
</.github/CONTRIBUTING.rst>`_
by adding novel tests, reporting or fixing bugs, and generally help us make
this a better software for everyone.
<https://memote.readthedocs.io/en/stable/contributing.html>`_ by adding novel
tests, reporting or fixing bugs, and generally help us make this a better
software for everyone.

Copyright
=========

* Copyright (c) 2017 Novo Nordisk Foundation Center for Biosustainability,
* Copyright (c) 2017, Novo Nordisk Foundation Center for Biosustainability,
Technical University of Denmark.
* Free software: `Apache Software License 2.0 <LICENSE>`_

Expand All @@ -92,7 +93,8 @@ Copyright
Credits
=======

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
This package was created with Cookiecutter_ and the
`audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

0 comments on commit a5f7125

Please sign in to comment.