Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.46 KB
Raw

Contributing to Surfactant

Thank you for considering contributing to our project! We appreciate your help.

Reporting Issues

  1. If you find a bug or have a feature request, please open a new issue and provide detailed information about the problem.
  2. If you find security issues or vulnerabilities, please report here

Making Contributions

We welcome contributions from the community. To contribute to this project, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.

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

For Developers:

  1. Create a virtual environment with python >= 3.8 [Optional, but recommended]
python -m venv cytrics_venv
source cytrics_venv/bin/activate
  1. Clone sbom-surfactant
git clone [email protected]:LLNL/Surfactant.git
  1. Create an editable surfactant install (changes to code will take effect immediately):
pip install -e .

To install optional dependencies required for running pytest and pre-commit:

pip install -e ".[test,dev]"

pip install with the -e or --editable option can also be used to install Surfactant plugins for development.

Code of Conduct

All participants in the Surfactant community are expected to follow our Code of Conduct.