You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ By participating in this project, you agree to abide by its terms.
13
13
### Prerequisites
14
14
15
15
Before you begin, ensure you have the following installed:
16
-
- Python 3.7 or later
16
+
- Python 3.10 or later
17
17
- Git
18
18
19
19
### Setting Up Your Development Environment
@@ -29,8 +29,12 @@ cd ps-fuzz
29
29
### Set up a virtual environment
30
30
31
31
```bash
32
-
python -m venv venv
32
+
# Unix or macOS
33
+
python3.10 -m venv venv
33
34
source venv/bin/activate # On Unix or macOS
35
+
36
+
# Windows
37
+
py -3.10 -m venv venv
34
38
venv\Scripts\activate # On Windows
35
39
```
36
40
@@ -128,7 +132,7 @@ from ..attack_config import AttackConfig
128
132
from ..test_base import TestBase, StatusUpdate
129
133
from ..attack_registry import register_test
130
134
from typing import Generator
131
-
frompkg_resourcesimportresource_filename
135
+
from.utilsimportpackaged_attack_data_path
132
136
import logging
133
137
logger = logging.getLogger(__name__)
134
138
```
@@ -208,4 +212,3 @@ Here are some helpful resources to get you started with best practices for contr
208
212
-[GitHub Flow](https://guides.github.com/introduction/flow/) - An introduction to the GitHub workflow, which explains branches, pull requests, and more.
209
213
-[Writing Good Commit Messages](https://chris.beams.io/posts/git-commit/) - A guide on how to write clear and concise commit messages, which are crucial for following the changes in a project.
210
214
-[Python Coding Style](https://pep8.org/) - Guidelines for writing clean and understandable Python code.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,6 +83,7 @@ Table of Contents
83
83
1. Install the Fuzzer package
84
84
<aid="using-pip"></a>
85
85
#### Using pip install
86
+
Requires Python 3.10 or newer.
86
87
```zsh
87
88
pip install prompt-security-fuzzer
88
89
```
@@ -327,4 +328,3 @@ Turn this into a community project! We want this to be useful to everyone buildi
327
328
Interested in contributing to the development of our tools? Great! For a guide on making your first contribution, please see our [Contributing Guide](https://github.com/prompt-security/ps-fuzz/blob/main/CONTRIBUTING.md#get-started-with-your-first-contribution-adding-a-new-test). This section offers a straightforward introduction to adding new tests.
328
329
329
330
For ideas on what tests to add, check out the issues tab in our GitHub repository. Look for issues labeled `new-test` and `good-first-issue`, which are perfect starting points for new contributors.
0 commit comments