Skip to content

Commit

Permalink
feat(release): Add CHANGELOG, Update Version
Browse files Browse the repository at this point in the history
Signed-off-by: Kaushlendra Pratap <[email protected]>
  • Loading branch information
Kaushl2208 committed Jan 23, 2025
1 parent 2e562bc commit 1f3a956
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 1 deletion.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- SPDX-FileCopyrightText: © Fossology contributors
SPDX-License-Identifier: LGPL-2.0-only
-->

<!-- Search if the Issue do not already exists in the issues (https://github.com/fossology/safaa/issues). -->

## Description

Please describe your situation in few words here.

### How to reproduce

For a bug: Describe the bug and list the steps you used when the issue occurred.

For an enhancement or new feature: Describe your needs/expected results.

### Screenshots

If applicable, add screenshots to help explain your problem.

### Versions

* Last commit id on master:
* Operating System (lsb_release -a):

### Logs

Any logs (if any) generated in

### FOSSology logs (if applicable)

Logs generated under /var/log/fossology/fossology.log
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- SPDX-FileCopyrightText: © Fossology contributors
SPDX-License-Identifier: LGPL-2.0-only
-->

<!-- Search if the bug do not already exists in the issues (https://github.com/fossology/safaa/issues). -->
<!-- Please refer to CONTRIBUTING.md (https://github.com/fossology/fossology/blob/master/CONTRIBUTING.md)
before creating the pull request to make sure you follow all the standards. -->

## Description

Please describe the changes in your pull request in few words here.

### Changes

List the changes done to fix a bug or introducing a new feature.

## How to test

Describe the steps required to test the changes proposed in the pull request.

Please consider using the closing keyword if the pull request is proposed to
fix an issue already created in the repository
(https://help.github.com/articles/closing-issues-using-keywords/)
47 changes: 47 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- SPDX-FileCopyrightText: © Fossology contributors
SPDX-License-Identifier: LGPL-2.0-only
-->
# Changelog for Safaa

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/).

---

## Safaa 0.0.2 (2025-01-23)
This release introduces a new model for incremental learning using scikit-learn's SGD Classifier. The model is trained on the provided dataset and can be used for incremental learning tasks. Dependencies have been pinned to avoid conflicts and a pkl file has been added to the repository.
### Authors:
```
> Kaushlendra Pratap <[email protected]>
> Gaurav Mishra <[email protected]>
```
### Changes:
* `b6d6999` fix(safaa): Pin conflicting dependencies and pkl file
* `28df119` Update: Introduced scikit-learn based SGD Classifier model for incremental learning
* `95b4623` feat(cd): use oidc instead of token
---



## Safaa 0.0.1 (2023-11-2)

This release introduces the Safaa package, which includes a false positive detector and a named entity recognition model. The package can be used to preprocess data, predict false positives, declutter copyright notices, train models, and save trained models.
### Authors:
```
> Gaurav Mishra <[email protected]>
> Hero2323 <[email protected]>
```

### Changes:
* `e9188b8` fix(package): fix pypi warnings
* `3c56981` fix(cd): add the correct directory path
* `d36aa6e` feat(ci): lint and publish
* `97e9af6` chore(repo): make reuse compliant
* `8d9008d` Update Safaa/setup.py
* `325a503` Update Safaa/MANIFEST.in
* `87cf656` Update README.md
* `d2eb6c5` updated package to safaa instead of Safaa, updated the license
* `1a56c90` Updated the data conversion file documentation
* `5f8a609` Added the package code after renaming it to Safaa, added training scripts for false positive detection, the datasets, as well as utility conversion scripts
---
2 changes: 1 addition & 1 deletion Safaa/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

setup(
name="safaa",
version="0.0.1",
version="0.0.2",
url="https://github.com/fossology/safaa",
author="Abdelrahman Jamal",
author_email="[email protected]",
Expand Down

0 comments on commit 1f3a956

Please sign in to comment.