Skip to content

Commit

Permalink
Add local development and release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaudcolas committed Apr 29, 2021
1 parent c074b95 commit e2e9f1b
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

## Install

To make changes to this project, first clone this repository:

```sh
git clone [email protected]:torchbox/buckup.git
cd buckup
```

With your preferred virtualenv activated, install testing dependencies:

```sh
pip install -e .
```

## Releases

First make sure to update the version number in `setup.cfg` and the CHANGELOG. Then,

```sh
pip install wheel twine
rm -rf dist/*
python setup.py sdist bdist_wheel
twine upload dist/*
```

0 comments on commit e2e9f1b

Please sign in to comment.