Skip to content

Commit

Permalink
Update contribution guideliens to include git-lfs
Browse files Browse the repository at this point in the history
  • Loading branch information
pavithraes committed Jan 30, 2024
1 parent e8fb224 commit 6d636f0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/community/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,29 @@ mkdocs serve

This serves the docs website at [http://127.0.0.1:8000](http://127.0.0.1:8000).

### View, add, or update images

Ragna tracks all image files with [`git-lfs`](https://git-lfs.com).

As a first-time user of `git-lfs`, set it up with:

```bash
git lfs install
```

To pull all image files to your local repository, run:

```bash
git lfs pull
```

All new or updated images will be tracked by `git-lfs`. To verify the files being
tracked, run:

```bash
git lfs ls-files
```

## Contribution best practices

- Before opening new issues, go through the tracker to ensure there aren't any previous
Expand Down
1 change: 1 addition & 0 deletions environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ channels:
dependencies:
- python =3.9
- pip
- git-lfs
- pip:
- python-dotenv
- boto3
Expand Down

0 comments on commit 6d636f0

Please sign in to comment.