Skip to content

Commit 2d8e291

Browse files
docs: add GETTING_STARTED.md
1 parent b67d2eb commit 2d8e291

File tree

3 files changed

+1107
-11
lines changed

3 files changed

+1107
-11
lines changed

.github/workflows/release-simunet.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ jobs:
111111
- name: Run pytest for simunet
112112
run: |
113113
echo "Running pytest for simunet..."
114-
poetry run pytest -v --tb=short -m "simunet or not agent"
114+
poetry run pytest -v --tb=short --mock-dev
115115
116116
build-and-publish:
117117
name: Build and Publish Simunet to PyPI

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Thank you for your interest in contributing to NetDriver! We welcome contributio
1414
- [Pull Request Process](#pull-request-process)
1515
- [Reporting Bugs](#reporting-bugs)
1616
- [Feature Requests](#feature-requests)
17-
- [Contact](#contact)
1817

1918
## Code of Conduct
2019

@@ -163,7 +162,7 @@ async def execute_command(
163162

164163
**Good examples:**
165164

166-
```
165+
```text
167166
Add Cisco ASA plugin support
168167
169168
Fix session timeout handling in SessionPool
@@ -176,7 +175,7 @@ Update documentation for plugin development
176175

177176
**Bad examples:**
178177

179-
```
178+
```text
180179
fixed stuff
181180
update
182181
changes
@@ -398,13 +397,14 @@ What actually happens
398397
- Device: Cisco Nexus 9000
399398

400399
## Logs
401-
```
400+
401+
```text
402402
Paste relevant logs here
403403
```
404404

405405
## Screenshots
406+
406407
[Attach screenshots if applicable]
407-
```
408408

409409
## Feature Requests
410410

@@ -438,7 +438,7 @@ Any other relevant information
438438

439439
Understanding the project structure will help you contribute effectively:
440440

441-
```
441+
```text
442442
netdriver/
443443
├── bases/netdriver/ # Applications
444444
│ ├── agent/ # REST API service
@@ -466,10 +466,10 @@ netdriver/
466466
- Open an [issue](https://github.com/OpenSecFlow/netdriver/issues) for questions
467467
- Check existing [documentation](https://github.com/OpenSecFlow/netdriver/blob/master/README.md)
468468
- Contact the maintainers:
469-
470-
471-
472-
469+
470+
471+
472+
473473

474474
## Recognition
475475

0 commit comments

Comments
 (0)