Skip to content

Commit

Permalink
update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wangmot committed Jan 30, 2025
1 parent cfa98df commit e2c8cc4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ We welcome contributions from the community. To contribute to this project, foll

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. ( This is an optional dependency: We are uing pre-commit hooks to adhere to coding standards. They will run automatically each time a commit is made. If any hook fails, the issues will need to be fixed before committing again.)

All contributions to EyeON are made under the MIT license (MIT).

Expand All @@ -31,6 +32,25 @@ source venv/bin/activate
git clone [email protected]:LLNL/pEyeON.git
```

3. Build the docker image and run the container
To build the image, run docker-build.sh:
```bash
./docker-build.sh
```

To run the container, run docker-run.sh:
```bash
./docker-run.sh
```

4. Optional Dependencies
There are a few dev related dependencies and 1 docs dependency that can be optionally installed.
```bash
pip install .[dev, docs] or
pip install .[dev] or
pip install .[docs]
```

## Code of Conduct

All participants in the EyeON community are expected to follow our [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
Expand Down

0 comments on commit e2c8cc4

Please sign in to comment.