<commit_before># Skeleton

This document explains project skeleton conventions.


## Directories

What do those directories in this project mean?

* bin - Script entry points.
* lib - The actual project code.
* test - Unit tests for the project code.
* doc - Documentation files
* build - Build directory in which `ant` puts it's results.

You may leave some of those directories out if they don't apply to the purpose of this skeleton.
Some directories may also have different names according to language and package specifications. Those have priority over this document.


## Configs

Standardized files for every project.

* README.md - The readme explaining how to install required dependencies and brief usage examples.
* build.xml - An `ant` build.xml that runs all metrics, checks, tests and builds when invoking `ant` without any additional arguments.


## Scripts

* run-tests.sh - A wrapper script that executes the unit test suite of this project.
* run-lint-check.sh - Lint check wrapper script.
* run-code-style-check.sh - Code style check wrapper script.

The purpose of those wrapper scripts is to provide a unified name across all project skeletons.<commit_msg>update skeleton conventions<commit_after># Skeleton

This document explains project skeleton conventions.


## Directories

Unified directories for all projects. Create them only if necessary.

* bin - Script entry points.
* lib - The actual project code.
* test - Unit tests for the project code.
* doc - Documentation files.
* build - Files, executables and reports generated during build.


## Files

Unified files and scripts for all projects. All mentioned scripts have the argument `--ci-mode` to also write reports to `build` rather than just print them.

* README.md - The readme explaining how to install required dependencies and brief usage examples.
* build.sh - Builds the project including metrics, checks and tests.
* run-tests.sh - Run tests, provide access to individual test suites.
* run-style-check.sh - Code style and lint checks.
* run-metrics.sh - Collect metrics.
{'fraction_non_alphanumeric': 0.06295399515738499, 'fraction_numerical': 0.0, 'mean_word_length': 3.9663461538461537, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6087835', 'n_tokens_mistral': 527, 'n_tokens_neox': 500, 'n_words': 274}