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

docs: fix typo and DOI badge #3

Merged
merged 5 commits into from
Jun 7, 2024
Merged

docs: fix typo and DOI badge #3

merged 5 commits into from
Jun 7, 2024

Conversation

maehr
Copy link
Owner

@maehr maehr commented Jun 4, 2024

Pull request

Proposed changes

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the README document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Summary by CodeRabbit

  • Documentation

    • Updated the title in README.md to "Manual for the creation of non-discriminatory metadata for historical sources and research data."
    • Modified DOI badge URL in README.md.
  • New Features

    • Enhanced metadata entries in the manual with ISO language codes and Wikidata links for better context and accessibility.
  • Chores

    • Updated git-cliff to version 2.3.0 and prettier to version 3.3.1 in package.json.

Copy link

coderabbitai bot commented Jun 4, 2024

Warning

Rate limit exceeded

@maehr has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 43 minutes and 34 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 12d1a4f and c19b773.

Walkthrough

The recent updates primarily involve documentation refinements and minor version increments for dependencies. The README.md title was changed to a more descriptive one, and the DOI badge URL was updated. The manuscript file had its language metadata and publisher information adjusted for better clarity and accuracy. Finally, the package.json saw minor version bumps for git-cliff and prettier.

Changes

File Change Summary
README.md Updated title to "Manual for the creation of non-discriminatory metadata for historical sources and research data".
manuscript/handbuch-diskriminierungsfreie-metadaten.qmd Updated language metadata to ISO codes with links, added Wikidata link for Publisher, and adjusted Rights and Relation fields.
package.json Incremented versions of git-cliff from 2.2.2 to 2.3.0 and prettier from 3.3.0 to 3.3.1.

Poem

In fields of code where changes bloom,
A title shifts, dispelling gloom.
Metadata gleams with clearer light,
Dependencies take their flight.
With every tweak, we craft anew,
A better world for me and you.
🐇✨


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 your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2204a3d and e2f18e4.

Files selected for processing (1)
  • README.md (2 hunks)
Additional context used
LanguageTool
README.md

[uncategorized] ~15-~15: A comma may be missing after the conjunctive/linking adverb ‘Furthermore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...earch data. It is available in German. Furthermore this repository contains a mapping of t...


[uncategorized] ~26-~26: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s organized as follows: - manuscript/: the manuscript of the publication - `ma...


[grammar] ~30-~30: Did you mean the formatting language “Markdown” (= proper noun)? (MARKDOWN_NNP)
Context: ...e-metadaten.qmd: the main document, in markdown format - manuscript/custom-reference.d...


[style] ~56-~56: Consider replacing this word to strengthen your wording. (AND_THAT)
Context: ...map This handbook is a living document and will be updated regularly. The discussi...


[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...sion of the handbook is open to everyone and we welcome feedback and suggestions for...

Additional comments not posted (2)
README.md (2)

1-1: Title change looks good and aligns with the project's scope.


10-10: DOI badge URL update is correct and functional.

Copy link

@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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e2f18e4 and 0d97728.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !pnpm-lock.yaml
Files selected for processing (2)
  • manuscript/handbuch-diskriminierungsfreie-metadaten.qmd (6 hunks)
  • package.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • package.json
Additional comments not posted (4)
manuscript/handbuch-diskriminierungsfreie-metadaten.qmd (4)

552-552: Updated Language field to use ISO language code enhances metadata specificity and interoperability.


602-602: Standardizing the Language field with ISO language codes improves metadata clarity and adherence to international standards.


603-603: Addition of more links in the Relation field enriches the metadata by providing more context and resources.


604-604: Simplifying the Rights field to "Public Domain" clarifies usage rights and reduces potential confusion.

@maehr maehr requested review from koilebeit and mtwente June 7, 2024 09:35
Copy link

@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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d97728 and 12d1a4f.

Files selected for processing (1)
  • README.md (2 hunks)
Additional context used
LanguageTool
README.md

[uncategorized] ~15-~15: A comma may be missing after the conjunctive/linking adverb ‘Furthermore’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...earch data. It is available in German. Furthermore this repository contains a mapping of t...


[uncategorized] ~26-~26: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s organized as follows: - manuscript/: the manuscript of the publication - `ma...


[grammar] ~30-~30: Did you mean the formatting language “Markdown” (= proper noun)? (MARKDOWN_NNP)
Context: ...e-metadaten.qmd: the main document, in markdown format - manuscript/custom-reference.d...


[style] ~56-~56: Consider replacing this word to strengthen your wording. (AND_THAT)
Context: ...map This handbook is a living document and will be updated regularly. The discussi...


[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...sion of the handbook is open to everyone and we welcome feedback and suggestions for...

Additional comments not posted (2)
README.md (2)

1-1: Title updated to reflect the broader scope of the project.


10-10: DOI badge URL updated to include the DOI number.

@maehr maehr merged commit ca8f5bf into main Jun 7, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants