Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Commit

Permalink
adding CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
jstoiko committed Apr 9, 2015
1 parent c6677ec commit ad37bef
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Team members

In alphabetical order:

* [Artem Kostiuk](https://github.com/postatum)
* [Chris Hart](https://github.com/chrstphrhrt)
* [Jonathan Stoikovitch](https://github.com/jstoiko)

## Pull-requests

Pull-requests are welcomed!

## Testing

1. Install dev requirements by running `pip install -r requirements.dev`
2. Run tests using `py.test [optional/path/to/tests]`

You can also enable coverage reports when running tests by using ``--cov slashed/path`` option to specify a path to package report for which should be gathered, and ``--cov-report (html|xml|annotate)`` to specify type of coverage report you want to receive.

Use `-v` to make tests output more verbose.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,6 @@
[![Build Status](https://travis-ci.org/brandicted/nefertari.svg?branch=master)](https://travis-ci.org/brandicted/nefertari)
[![Documentation Status](https://readthedocs.org/projects/nefertari/badge/?version=master)](https://readthedocs.org/projects/nefertari/?badge=master)


Nefertari is a REST API framework sitting on top of [Pyramid](https://github.com/Pylons/pyramid) and [ElasticSearch](https://www.elastic.co/downloads/elasticsearch). She currently offers two backend engines: [SQLA](https://github.com/brandicted/nefertari-sqla) and [MongoDB](https://github.com/brandicted/nefertari-mongodb).

You can read the documentation on [readthedocs](https://nefertari.readthedocs.org/en/latest/).

### Development
To run tests:
1. Install dev requirements by running ``pip install -r requirements.dev``.
2. Run tests using ``py.test [optional/path/to/tests]`

You can also enable coverage reports when running tests by using ``--cov slashed/path`` option to specify a path to package report for which should be gathered, and ``--cov-report (html|xml|annotate)`` to specify type of coverage report you want to receive.

Use `-v` to make tests output more verbose.

0 comments on commit ad37bef

Please sign in to comment.