Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge develop into main: updated readme and number of list-based recommendations #62

Merged
merged 10 commits into from
Sep 5, 2024

Conversation

lilijap
Copy link
Contributor

@lilijap lilijap commented Sep 5, 2024

For authors

Description

  • updated README.md for non-developers and provided details on Zotero integration
  • reduced list-based recommendations to 50
  • negative articles no longer have to be provided

Fixes # (issue) NA

Merging develop into main

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • [X ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests you conducted to verify your changes. These may involve creating new test scripts or updating existing ones.

  • Added new test(s) in the tests folder
  • Added new function(s) to an existing test(s) (e.g.: tests/testX.py)
  • No new tests added (Please explain the rationale in this case)

Checklist

  • My code follows the style guidelines mentioned in the Code/DevOps guides
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (e.g. MkDocs)
  • My changes generate no new warnings
  • I have added or updated tests (in the tests folder) that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

For reviewers

Checklist pre-approval

  • Is there enough documentation?
  • If a new feature has been added, or a bug fixed, has a test been added to confirm good behavior?
  • Does the test(s) successfully test edge/corner cases?
  • Does the PR pass the tests? (if the repository has continuous integration)

Checklist post-approval

  • Does this PR merge develop into main? If so, please make sure to add a prefix (feat/fix/chore) and/or a suffix BREAKING CHANGE (if it's a major release) to your commit message.
  • Does this PR close an issue? If so, please make sure to descriptively close this issue when the PR is merged.

Checklist post-merge

  • When you approve of the PR, merge and close it (Read this article to know about different merge methods on GitHub)
  • Did this PR merge develop into main and is it suppose to run an automated release workflow (if applicable)? If so, please make sure to check under the "Actions" tab to see if the workflow has been initiated, and return later to verify that it has completed successfully.

gurdeep330 and others added 6 commits August 8, 2024 13:19
fix: changes on positive and negative articles due to Semantic Scholar Recommendation API restriction removal, close #47
* update data

* update data

* feat: add Zotero plugin

* chore: update README explaining the Zotero plugin

* chore: utils.py and reduce the number of articles to 200

---------

Co-authored-by: GitHub Action <action@github.com>
…les (#61)

* feat: updated README and restricting list-based recommendations to 50 articles

* fix: fix the icons in README
@lilijap lilijap self-assigned this Sep 5, 2024
Copy link
Member

@gurdeep330 gurdeep330 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All-clear!
Waiting for @awmulyadi.

Copy link
Contributor

@awmulyadi awmulyadi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice detailed updates on the readme file and recommendation settings 😎

@awmulyadi awmulyadi merged commit b2924bb into main Sep 5, 2024
6 checks passed
Copy link
Contributor

github-actions bot commented Sep 5, 2024

🎉 This PR is included in version 3.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants