Skip to content

Commit 5719982

Browse files
committed
Added contributing info from legacy repo
1 parent 9adfaad commit 5719982

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
Any community support for the development of ForceFinder is welcomed. This support could come in many forms:
3+
4+
- Code development for inverse methods
5+
- Code development for error metrics
6+
- Code development for unit and integration tests
7+
- Using the package and reporting bugs
8+
- Using the package and reporting workflow pain points
9+
10+
Additional development dependencies may be installed for those that are supporting code development, which makes it easy to run the tests and build the documentation. These extra dependencies can be installed with one of two methods:
11+
12+
- pip install -e .[dev]
13+
- pip install -r requirements-dev.txt

requirements-dev.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
pytest
2+
pytest-cov
3+
jupyter-book
4+
sphinx-autoapi

0 commit comments

Comments
 (0)