Skip to content

Create project-structure #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CRF1408 wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Create project-structure #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/project-structure
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Project structure

This doc explains the main folders and where to add new code.

- `scripts/` — runnable scripts and examples
- `docs/` — documentation and how-to guides
- `tests/` — automated tests (unit/integration)

## Adding a new script

1. Create a new file under `scripts/`.
2. Keep it small and focused.
3. Prefer environment variables for configuration.
4. Add a short header comment describing usage.

## Adding docs

Put new docs in `docs/` and keep them task-oriented.