|
| 1 | +## Unreleased |
| 2 | + |
| 3 | +### Added |
| 4 | + |
| 5 | +- [Changelog page](https://slimeslab.github.io/ComProScanner/about/changelog/) added in the documentation. Also, [CHANGELOG.md](https://github.com/slimeslab/ComProScanner/blob/main/CHANGELOG.md) linked in [README.md](https://github.com/slimeslab/ComProScanner/blob/main/README.md). |
| 6 | + |
| 7 | +- Added DeepWiki integration badge to README.md for community Q&A support: [Ask DeepWiki](https://deepwiki.com/slimeslab/ComProScanner) |
| 8 | +- Added arXiv preprint badge to README.md: [arXiv:2510.20362](https://arxiv.org/abs/2510.20362) |
| 9 | + |
| 10 | +- [CITATION.cff](https://github.com/slimeslab/ComProScanner/blob/main/CITATION.cff) added for standardized citation information based on the latest release and arXiv preprint. |
| 11 | + |
| 12 | +### Changed |
| 13 | + |
| 14 | +- Moved the README badges section from html `p` tags to markdown format for better compatibility across platforms. |
| 15 | + |
| 16 | +## [0.1.4] - 02-12-2025 |
| 17 | + |
| 18 | +### Added |
| 19 | + |
| 20 | +- New function `clean_data()` added for improved data cleaning and preprocessing instead of integrating it into data extraction function. |
| 21 | + |
| 22 | +- New documentation page for Data Cleaning added: |
| 23 | + |
| 24 | + - docs/usage/data-cleaning.md |
| 25 | + - Added to mkdocs.yml navigation. |
| 26 | + |
| 27 | +- New API overview documentation page added: |
| 28 | + |
| 29 | + - docs/api.md |
| 30 | + - Added to mkdocs.yml navigation. |
| 31 | + - New mkdocstrings configuration added to mkdocs.yml for automatic API documentation generation. |
| 32 | + |
| 33 | +- New tests added for remaining utils functions. |
| 34 | + |
| 35 | +- Added pytest coverage tracking (50%) using `pytest-cov` and coverage report generation using _codecov_. |
| 36 | + |
| 37 | +### Fixed |
| 38 | + |
| 39 | +- Tests updated to reflect changes in data cleaning process. |
| 40 | + |
| 41 | +### Removed |
| 42 | + |
| 43 | +- Arguments related to data cleaning removed from data extraction function. |
| 44 | + |
| 45 | +### Changed |
| 46 | + |
| 47 | +- README images updated with raw GitHub links for better reliability: [ComProScanner Logo](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/comproscanner_logo.png), [ComProScanner Workflow](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/overall_workflow.png) |
| 48 | + |
| 49 | +## [0.1.3] - 04-11-2025 |
| 50 | + |
| 51 | +### Fixed |
| 52 | + |
| 53 | +- **RecursiveCharacterTextSplitter** importing updated for latest _langchain_ version to avoid import errors: |
| 54 | + - Changed from `from langchain.text_splitter import RecursiveCharacterTextSplitter` |
| 55 | + - To `from langchain.text_splitter.recursive_character import RecursiveCharacterTextSplitter` |
| 56 | + |
| 57 | +## [0.1.2] - 24-10-2025 |
| 58 | + |
| 59 | +### Added |
| 60 | + |
| 61 | +- Link to ComProScanner preprint on arXiv in the documentation index page and README.md: [arXiv:2510.20362](https://arxiv.org/abs/2510.20362) |
| 62 | + |
| 63 | +## [0.1.1] - 22-10-2025 |
| 64 | + |
| 65 | +### Fixed |
| 66 | + |
| 67 | +- README images updated with external image link to fix PyPI rendering issue. [ComProScanner Logo](https://i.ibb.co/whHSbGvT/comproscanner-logo.png), [ComProScanner Workflow](https://i.ibb.co/QWd2qd3/overall-workflow.png) |
| 68 | + |
| 69 | +## [0.1.0] - 22-10-2025 |
| 70 | + |
| 71 | +### Added |
| 72 | + |
| 73 | +- Initial release of ComProScanner. |
0 commit comments