MediaImporter
/
README.md
Newer
■
■
■
■
■
■
■
■
■
■
Older
38 lines
|
1.856kb
| 1 |
# Media Importer Project |
|
| 2 | ||
| 3 |
This repository contains the development and testing resources for the `media-importer.sh` script, which is the main product of this project. |
|
| 4 | ||
| 5 |
## Project Structure |
|
| 6 | ||
| 7 |
- `media-importer.sh`: The primary script under development and testing. |
|
| 8 |
- `AGENTS.md`: Safety rules for agents or unattended automation that copy, derive, or run the importer. |
|
| 9 |
- `INCIDENTS.md`: Postmortems for data-loss or near-data-loss incidents and the regression rules derived from them. |
|
| 10 |
- `sample/`: Contains local media fixtures used for development and testing. **Note:** Scripts and functions are not imported from sample directories. |
|
| 11 | ||
| 12 |
## Version Control |
|
| 13 | ||
| 14 |
Version control is implemented for all files except the `samples/` directory. The `samples/` directory is excluded from version control to avoid tracking test resources and sample files. |
|
| 15 | ||
| 16 |
To exclude the `samples/` directory, the following entry should be added to the `.gitignore` file: |
|
| 17 | ||
| 18 |
```gitignore |
|
| 19 |
samples/ |
|
| 20 |
``` |
|
| 21 | ||
| 22 |
## Contribution Guidelines |
|
| 23 | ||
| 24 |
- All development should focus on `media-importer.sh`. |
|
| 25 |
- Do not import, source, or derive importer behavior from sample directories. |
|
| 26 |
- Use sample media only for testing and development reference. |
|
| 27 |
- Do not use removed Raspberry Pi / unattended wrapper prototypes as a reference design; they were based on an outdated, unvalidated importer copy. |
|
| 28 |
- Destination conflicts must never be delegated to copy/move tools. In unattended runs the importer appends numeric suffixes (`_1`, `_2`, ...); in interactive runs it asks the user and supports applying the choice to all similar conflicts. |
|
| 29 | ||
| 30 |
## License |
|
| 31 | ||
| 32 |
Specify your license here. |
|
| 33 | ||
| 34 |
--- |
|
| 35 | ||
| 36 |
For details on recent changes, including the removal of fallback date handling, see [CHANGELOG.md](./CHANGELOG.md). |
|
| 37 | ||
| 38 |
This file is intended for GitHub Copilot and contributors to understand the project structure and guidelines. |