Skip to content

Commit ad47068

Browse files
adhadsemattdangerw
andauthored
Updated CONTRIBUTING.md for setup of venv and standard pip install (#127)
* Updated CONTRIBUTING.md for setup of venv and standard pip install * Updated CONTRIBUTING.md with proposed changes * Fixes Co-authored-by: Matt Watson <[email protected]>
1 parent f41ec82 commit ad47068

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@ development environment and run the unit tests. This is covered in section
2626
### Step 3. Create a pull request
2727

2828
Once the change is ready, open a pull request from your branch in your fork to
29-
the master branch in [keras-team/keras-nlp](https://github.com/keras-team/keras-nlp).
29+
the master branch in
30+
[keras-team/keras-nlp](https://github.com/keras-team/keras-nlp).
3031

3132
### Step 4. Sign the Contributor License Agreement
3233

3334
After creating the pull request, you will need to sign the Google CLA agreement.
34-
The agreement can be foiund at [https://cla.developers.google.com/clas](https://cla.developers.google.com/clas).
35+
The agreement can be found at
36+
[https://cla.developers.google.com/clas](https://cla.developers.google.com/clas).
3537

3638
### Step 5. Code review
3739

@@ -47,20 +49,24 @@ Once the pull request is approved, a team member will take care of merging.
4749

4850
## Setup environment
4951

52+
Python 3.7 or later is required.
53+
5054
Setting up your KerasNLP development environment requires you to fork the
51-
KerasNLP repository, clone the repository, install dependencies, and execute
52-
`python setup.py develop`.
55+
KerasNLP repository, clone the repository, create a virtual environment, and
56+
install dependencies.
5357

5458
You can achieve this by running the following commands:
5559

5660
```shell
5761
gh repo fork keras-team/keras-nlp --clone --remote
5862
cd keras-nlp
59-
pip install ".[tests]"
60-
python setup.py develop
63+
python -m venv ~/keras-nlp-venv
64+
source ~/keras-nlp-venv/bin/activate
65+
pip install -e ".[tests]"
6166
```
6267

63-
The first line relies on having an installation of [the GitHub CLI](https://github.com/cli/cli).
68+
The first line relies on having an installation of
69+
[the GitHub CLI](https://github.com/cli/cli).
6470

6571
Following these commands you should be able to run the tests using
6672
`pytest keras_nlp`. Please report any issues running tests following these
@@ -114,4 +120,5 @@ like - `: invalid option`
114120

115121
## Community Guidelines
116122

117-
This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct/).
123+
This project follows
124+
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).

0 commit comments

Comments
 (0)