Skip to content

Commit

Permalink
Update readme to add attribution step
Browse files Browse the repository at this point in the history
Signed-off-by: Judy Ng <njud@amazon.com>
  • Loading branch information
judysng committed Feb 14, 2024
1 parent 292103d commit 3cf0ce6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@ When working on the project, you may need to add/change a dependency.
### Product Dependencies
To add a product dependency, you should add the dependency with a specified version to the `requirements.in` file,
and generate `requirements.txt` using [pip-tools](https://github.com/jazzband/pip-tools),
which is part of dev dependencies (`requirements-dev.txt`)
which is part of dev dependencies (`requirements-dev.txt`). Then update the attribution document in
`frontend/resources/attributions/npm-python-attributions.txt` accordingly
in the "Python third party dependencies" section.

When changing a dependency in the frontend project you should add/Change it in `frontend/package.json`,
re-generate `frontend/package-lock.json` with `npm install`
and update the attribution document in `frontend/resources/attributions/npm-python-attributions.txt` accordingly.
and update the attribution document in `frontend/resources/attributions/npm-python-attributions.txt` accordingly
in the "Javascript third party dependencies" section.

### Dev Dependencies
To add/change a development dependencies, you can directly change `requirements-dev.txt`.
Expand Down

0 comments on commit 3cf0ce6

Please sign in to comment.