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 'Introduction to Python for Humanists' #85

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Conversation

koilebeit
Copy link
Collaborator

@koilebeit koilebeit commented Jan 22, 2024

Pull Request

Add Introduction to Python for Humanists in src/lib/data/entries.json.

Short pitch

see #80

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
    • Added "Introduction to Python for Humanists" to the historical and digital history resources list.

Copy link
Contributor

coderabbitai bot commented Jan 22, 2024

Walkthrough

The addition of "Introduction to Python for Humanists" expands the range of programming resources available to researchers and students in the humanities.

Changes

File Change Summary
README.md Added "Introduction to Python for Humanists"

🐇💻
To code or not to code, a humanist ponders,
Along came a rabbit with Python wonders.
"Fear not the script," it thumped with glee,
"For loops and functions shall set your data free!" 📚✨

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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 1b98dc4 and 59ed69b.
Files ignored due to path filters (1)
  • src/lib/data/entries.json is excluded by: !**/*.json
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

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 59ed69b and 60b80d5.
Files ignored due to path filters (1)
  • src/lib/data/entries.json is excluded by: !**/*.json
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • README.md

@maehr maehr merged commit f8497f4 into maehr:main Jan 23, 2024
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.

2 participants