Skip to content

Commit 84ae315

Browse files
committed
Create CONTRIBUTING.md
1 parent 54f4c04 commit 84ae315

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to pyABF
2+
3+
**pyABF welcomes contributions from the open source community!** The following information may make it easier to get started working with pyABF source code.
4+
5+
## Development Environment Setup
6+
7+
When working with Python projects I prefer the [VS Code editor](https://code.visualstudio.com/)
8+
9+
Install the latest version of Python from https://python.org
10+
11+
In a terminal, `cd` into this repository's top-level folder
12+
13+
Create a virtual environment: `python -m venv env`
14+
15+
Activate the virtual environment: `"env/Scripts/activate"`
16+
17+
Install the required packages: `pip install -r "src/requirements.txt"`
18+
19+
## Running Tests
20+
21+
In a terminal, `cd` into this repository's top-level folder
22+
23+
Activate the virtual environment: `"env/Scripts/activate"`
24+
25+
Run the tests: `pytest`

0 commit comments

Comments
 (0)