Added a release guide

CHANGELOG.md

@@ -1,3 +1,29 @@
+Release 0.7.0 October 2, 2025
+- Added comprehensive logging infrastructure with configurable log levels and file output to validation tools.
+- Enhanced validate_bids script with improved error reporting and filtering capabilities.
+- Added error code counting and filtering by count/file in ErrorHandler.
+- Improved validation output formatting with version tracking in JSON output.
+- Added comprehensive CONTRIBUTING.md with development guidelines and best practices.
+- Enhanced README.md with better documentation structure and examples.
+- Improved user guide documentation with clearer installation and usage instructions.
+- Fixed typos and improved code documentation throughout the codebase.
+- Enhanced Windows compatibility with normalized path handling in tests.
+- Updated pyproject.toml with improved metadata and dependencies.
+
+Release 0.6.0 August 7, 2024
+- Added MATLAB integration support with improved function visibility in __init__.py.
+- Enhanced ontology creation and validation with better handling of equivalent classes.
+- Improved schema scripts with migration from hed-schemas repository.
+- Added DataFrame loading/saving optimizations and folder-based operations.
+- Enhanced HED ID validation with more robust checks.
+- Improved sidecar and tabular input utilities with new helper functions.
+- Added support for empty tabular files and whitespace-only files.
+- Enhanced annotation utilities for better MATLAB compatibility.
+- Improved matplotlib compatibility and updated color map access.
+- Fixed various bugs in spreadsheet handling and schema loading.
+- Updated dependencies and improved Python 3.7+ compatibility.
+- Improved code quality with better type handling and error messages.
+
 Release 0.5.0
 - Added JSON schema specification of remodeling commands.
 - Added support for schema that are specified by .tsv files.

CONTRIBUTING.md

@@ -93,18 +93,18 @@ We use several tools to maintain code quality:
 
 Example docstring:
 ```python
-def validate_hed_string(hed_string, schema):
+def validate_hed_string(hed_string, schema)->list[dict]:
     """Validate a HED string against a schema.
 
-    Args:
+    Parameters:
         hed_string (str): The HED string to validate.
         schema (HedSchema): The schema to validate against.
 
     Returns:
         list: A list of validation issues, empty if valid.
 
     Example:
-        >>> schema = load_schema()
+        >>> schema = load_schema_version('8.4.0')
         >>> issues = validate_hed_string("Event", schema)
         >>> if not issues:
         ...     print("Valid!")
@@ -135,16 +135,16 @@ from hed import HedString, load_schema
 class TestHedValidation(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
-        cls.schema = load_schema()
+        cls.schema = load_schema_version('8.4.0')
 
     def test_valid_hed_string(self):
         hed_string = HedString("Event", self.schema)
-        issues = hed_string.validate(self.schema)
+        issues = hed_string.validate()
         self.assertEqual(len(issues), 0)
 
     def test_invalid_hed_string(self):
         hed_string = HedString("InvalidTag", self.schema)
-        issues = hed_string.validate(self.schema)
+        issues = hed_string.validate()
         self.assertGreater(len(issues), 0)
 
 if __name__ == '__main__':