Update Datasets README.md to clarify dataset contribution workflow

[Oufattole]

Clarified how collaborates should add their dataset predicates to the repo.

Summary by CodeRabbit

• New Features

  • Added a section in the README for contributing new datasets, outlining a clear four-step process.

• Documentation

  • Improved formatting of existing notes for better clarity and readability.

[coderabbitai]

Walkthrough

The changes in the README.md file within the src/MEDS_DEV/datasets directory include the addition of a new section that outlines a four-step process for contributing a new dataset. This process involves forking the repository, adding a dataset predicates file, testing the dataset locally, and creating a pull request. Additionally, the existing notes section has been reformatted into a numbered list for improved clarity and readability.

Changes

File Path	Change Summary
src/MEDS_DEV/datasets/README.md	Added a new section detailing the four-step process for contributing a new dataset. Reformatted notes section into a numbered list for clarity.

Poem

In the meadow where datasets grow,
A guide for contributors now starts to flow.
Fork, add, test, and then pull,
With numbered steps, it's clear and full.
Hop along, dear friends, join the fun,
Together we'll build, our work's just begun! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5ba2b18 and 6335cc1.

📒 Files selected for processing (1)

• src/MEDS_DEV/datasets/README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/MEDS_DEV/datasets/README.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/MEDS_DEV/datasets/README.md (2)

4-8: Excellent addition, with minor suggestions for improvement.

The new section on contributing a dataset is clear and helpful. To further enhance it, consider the following suggestions:

1. In step 3, provide more specific instructions on how to test locally, or link to a testing guide if one exists.
2. In step 2, mention the naming convention for the dataset predicates file (if there is one).
3. In step 4, consider adding a link to GitHub's documentation on creating pull requests for new contributors.

Example:

3. Test locally to ensure your dataset works correctly (refer to our testing guide [link])
4. Create a pull request with your changes (see GitHub's guide on [creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))

---

11-14: Good reformatting, with suggestions for clarity.

The reformatted notes section is more readable. To further improve it, consider:

1. Making the introductory sentence more concise. For example:

   If you need a more specialized task configuration file than can be achieved by overwriting predicates:

2. Providing more detail in step 1 about creating a GitHub issue. For example:

   1. Create a GitHub issue explaining why the existing file is insufficient and what specialized configuration is needed

These changes would make the instructions even clearer for contributors.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 30d5631 and 5ba2b18.

📒 Files selected for processing (1)

• src/MEDS_DEV/datasets/README.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

src/MEDS_DEV/datasets/README.md (1)

1-14: Overall, excellent improvements to the README.

The changes successfully clarify the process for collaborators to add their dataset predicates, which aligns well with the PR objectives. The new section on contributing datasets and the reformatted notes significantly enhance the documentation's clarity and usefulness. With the minor suggestions provided, this update will greatly assist contributors in understanding and following the correct procedures.