Developer Guide¶

Introduction¶

This guide, designed for a NLNZ Tools Scripts Ingestion developer and contributor, covers how to develop and contribute to the NLNZ Tools Scripts Ingestion. The source for both code and documentation can be found at: https://github.com/NLNZDigitalPreservation/nlnz-tools-scripts-ingestion/

Contents of this document¶

Following this introduction, the NLNZ Tools Scripts Ingestion includes the following sections:

Contributing - Covers how to contribute to the project.
Developer guidelines - Covers coding practice and development workflow.
Future milestones - Covers plans for future development.

Contributing¶

This describes how to contribute to the NLNZ Tools Scripts Ingestion project. General contribution guidelines follow the guidelines outlined in Contributing section of the Developer Guide of the National Library of New Zealand Developer Guidelines for a description of the build commands used for this project. These guidelines can be found at https://nlnz-developer-guidelines.readthedocs.io .

Source Code Repository¶

Source code for the NLNZ Tools Scripts Ingestion is stored in github at: https://github.com/NLNZDigitalPreservation/nlnz-tools-scripts-ingestion/ Contributors to the codebase will require a github account.

Major Contributors¶

Major contributors to NLNZ Tools Scripts Ingestion are NLNZ (The National Library of New Zealand) (https://natlib.govt.nz/). This institution currently drive most development. All contributors are welcome. Making your interest in NLNZ Tools Scripts Ingestion known can help to ensure that the tools meets your needs.

Contributors¶

See individual git commits to see who contributors are.

Tests¶

The scripts contain no validation tests except as noted within the script itself.

Developer Guidelines¶

See the National Library of New Zealand Developer Guidelines found at: https://nlnz-developer-guidelines.readthedocs.io .

Future milestones¶

See specific scripts for future plans for that specific script.

If there are plans for future scripts they would go here.