Skip to content

Commit

Permalink
Update contributing and readme with proposed changes from #92
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs authored and CasperWA committed Jan 7, 2020
1 parent cdf861d commit 8bc7494
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# Contribute to `optimade-python-tools`

The Materials-Consortia is very open to contributions to this package.
The [Materials Consortia](https://github.com/Materials-Consortia) is very open to contributions to this package.

This may be anything from simple feedback and raising [new issues](https://github.com/Materials-Consortia/optimade-python-tools/issues/new) to creating [new PRs](https://github.com/Materials-Consortia/optimade-python-tools/compare).

We have below recommendations for setting up an environment in which one may develop the package further.

## Development installation

The core dependencies of this package can be found in `requirements.txt` with
at the latest supported version. Individual backends and their supported
versions can be found in `setup.py`. The following "extra" install modes are
currently supported: `all`, `dev`, `server`, `testing`, `django`, `elastic` and `mongo`.

When contributing to the Python code, please use the
[black](https://github.com/ambv/black) code formatter. The
[flake8](http://flake8.pycqa.org/en/latest/) linter will be run automatically on
all PRs.



```shell
# Clone this repository to your computer
git clone git@github.com:Materials-Consortia/optimade-python-tools.git
Expand Down Expand Up @@ -42,8 +55,6 @@ open http://localhost:5000/docs
open http://localhost:5000/openapi.json
```

When contributing to the Python code, please use the [black](https://github.com/ambv/black) code formatter.

## Getting Started with Filter Parsing and Transforming

Example use:
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ This repository contains a library of tools for implementing and consuming [OPTi

Both the OPTiMaDe specification and this repository are **under development**.

## Installation & Contributing

See [CONTRIBUTING](CONTRIBUTING.md).


## Links

* [OPTiMaDe Specification](https://github.com/Materials-Consortia/OPTiMaDe/blob/develop/optimade.rst), the human-readable specification that this library is based on.
Expand All @@ -24,6 +29,3 @@ Both the OPTiMaDe specification and this repository are **under development**.
* [FastAPI](https://fastapi.tiangolo.com/), the framework used for generating the reference implementation from the [`openapi.json`](openapi.json) specification.
* [lark](https://github.com/lark-parser/lark), the library used to parse the filter language in OPTiMaDe queries.

## Developing

See [CONTRIBUTING](CONTRIBUTING.md).

0 comments on commit 8bc7494

Please sign in to comment.