Skip to content

Commit

Permalink
docs: add development environment setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jooyoungseo committed Feb 4, 2024
1 parent 2e4cf10 commit 36ecba2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

# Code Contribution

To contribute to this repository, please follow the steps below to set up your development environment.

First, install all the recommended VSCode extensions for this workspace when prompted.

Second, install poetry:

``` sh
pip install poetry

# In the project root directory
poetry install
```

Third, install pre-commit hooks which will automatically reformat and lint the code when you make a commit:

``` sh
poetry run pre-commit install
```
21 changes: 0 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,3 @@ To update the package to the latest version of this repository, please run:
``` sh
pip install --upgrade --no-deps --force-reinstall git+https://github.com/uiuc-ischool-accessible-computing-lab/py_maidr.git
```

## Code Contribution

To contribute to this repository, please follow the steps below to set up your development environment.

First, install all the recommended VSCode extensions for this workspace when prompted.

Second, install poetry:

``` sh
pip install poetry

# In the project root directory
poetry install
```

Third, install pre-commit hooks which will automatically reformat and lint the code when you make a commit:

``` sh
poetry run pre-commit install
```

0 comments on commit 36ecba2

Please sign in to comment.