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

Add PARC and HMML #84

Merged
merged 7 commits into from
Dec 20, 2023
Merged

Add PARC and HMML #84

merged 7 commits into from
Dec 20, 2023

Conversation

DominicWeber
Copy link
Contributor

@DominicWeber DominicWeber commented Dec 19, 2023

Pull Request

Add / Remove / Change {entry name} in src/lib/data/entries.json.

PARC is a collection of primary sources for African History.
HMML is a collection of digitized manuscripts from all over the world.

Describe why this change is made. Alternatively, refer to existing issues if any. You could try to answer:

  • Why do you find this resource awesome?
  • How do you use this resource in your workflow?
  • What advantages / disadvantages does it have compared to {another resource}?

Checklist

Please ensure that you have completed the following tasks:

  • I have read and understood the contribution guidelines.
  • I have run npm run prepare to sort the entries in src/lib/data/entries.json alphabetically and to generate the README.md file.
  • I have run npm run format to format the repository code.
  • I have run npm run awesome-lint to ensure that the README.md file is formatted correctly.

Criteria for accepting a pull request

Contributors, please ensure that:

Maintainers, please ensure that:

  • The above criteria are followed.
  • The tests pass on the CI.
  • In the case of addition or removal, make an assessment of the awesomeness of the entry.

Updating your PR

If the maintainers notice anything that needs to be changed, they will ask you to edit your PR before merging it. Please do not open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR.

Appendix: running lint tests

To run tests locally using Node.js, you need to install the dependencies first:

npm install
npm run prepare

Summary by CodeRabbit

  • Documentation
    • Expanded the list of archives and primary sources in the README.
      • New entry for the "PARC" meta-catalogue in the "Africa" section.
      • Added "HMML" to the list of resources with a corresponding link.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2023

Walkthrough

The README.md file has been updated to enhance its repository of resources. It now includes new entries for African research collections and a manuscript library, expanding the archival and primary source references available to users.

Changes

File Path Change Summary
README.md Added "PARC" entry under "Africa" with a new link; Added "HMML" entry with its link.

🐇
"In the README's garden, new flowers bloom,
PARC and HMML, they now have room.
Archives grow, knowledge unfurls,
A hop through history, as the world twirls." 📚🌍

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2508f5a and 3e52c15.
Files ignored due to filter (1)
  • src/lib/data/entries.json
Files selected for processing (1)
  • README.md (2 hunks)
Additional comments: 3
README.md (3)
  • 32-34: The entry for PARC is well-formatted and consistent with the other entries in the "Africa" section. The description is concise and informative.

  • 90-90: The entry for HMML is correctly placed in the "Global" section and follows the established format for resource listings.

  • 29-38: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [29-93]

Please ensure that npm run awesome-lint has been executed to verify that the formatting of the README.md file adheres to the project's standards.

@maehr
Copy link
Owner

maehr commented Dec 19, 2023

@DominicWeber Thanks for your contribution. Please add a region (or an empty region array) to the HMML entry and run npm run prepare and npm run awesome-lint to make sure everything works. I will try to make the error messages of the script more meaningful and add some clarifications to the docs in the meantime.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3e52c15 and f43eae5.
Files ignored due to filter (1)
  • src/lib/data/entries.json
Files selected for processing (1)
  • README.md (3 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

@DominicWeber
Copy link
Contributor Author

Done, although npm run awesome-lint failed due to invalid repo URL.

@maehr maehr merged commit e543b70 into maehr:main Dec 20, 2023
3 checks passed
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.

None yet

2 participants