Add CONTRIBUTIONG.md

[yu-iskw]

PR Type

Documentation

---

Description

• Added a new CONTRIBUTIONG.md file providing a comprehensive guide for contributing to the project, including development setup and policies.
• Updated README.md to include a note about the package's primary design for dbt-core and a link to the new contribution guide.
• Made minor formatting improvements in the README.md.

---

Changes walkthrough 📝

Relevant files

Documentation

CONTRIBUTIONG.md Add contribution guide with development instructions          CONTRIBUTIONG.md Added a new contribution guide for the project. Described the package's purpose and basic knowledge about dbt artifacts. Provided implementation policies and development setup instructions. Included steps to generate Pydantic models from dbt artifacts. +70/-0    README.md Update README with contribution guide link and notes          README.md Added a note about the package's design for dbt-core. Updated the contributors section with a link to the new contribution guide. Made minor formatting adjustments. +19/-6

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new CONTRIBUTING.md file that provides guidelines for contributing to the project, focusing on dbt artifacts in Python. The document outlines essential policies for maintaining generated Pydantic models and includes a development setup section. Additionally, the README.md has been updated to clarify the package's compatibility with dbt-core and to expand documentation on various JSON artifact formats, including new Python classes for multiple versions of catalog.json, manifest.json, and run-results.json.

Changes

File	Change Summary
CONTRIBUTING.md	Added a new file outlining contribution guidelines, including a welcome message, package purpose, implementation policies, and development setup instructions.
README.md	Updated to clarify that the package is designed for dbt-core, added sections on compatibility, expanded documentation for parsing various JSON artifact versions, and reformatted the contributors section. New classes added for catalog.json, manifest.json, and run-results.json across multiple versions (v1 to v12).

Possibly related PRs

• Support dbt 1.8 #75: The changes in this PR involve adding support for new versions of Manifest and Run Results, which are relevant to the guidelines for generating Pydantic models from dbt artifacts mentioned in the main PR.
• Update README.md #77: This PR updates the README to include new parsing functions for ManifestV12 and RunResultsV6, which aligns with the main PR's focus on generating Pydantic models from dbt artifacts.
• Migrate to pydantic v2 #78: This PR discusses migration to Pydantic v2, which is relevant to the implementation policies outlined in the main PR regarding the generation of Pydantic models from dbt artifacts.

🐰 In the garden where ideas bloom,
A guide for helpers finds its room.
With Pydantic models, clear and bright,
We parse the artifacts, day and night.
So hop along, contributors dear,
Your insights will bring us cheer! 🌼

---

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.

[qodo-merge-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Typo in Filename The filename "CONTRIBUTIONG.md" contains a typo. It should be "CONTRIBUTING.md". Inconsistent Formatting The document uses a mix of single and double backticks for code elements. Consistency should be maintained. Broken Link The link to CONTRIBUTING.md is incorrect due to the typo in the filename.

[qodo-merge-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Best practice	Correct the file name and title to follow standard open-source conventions The file name "CONTRIBUTIONG.md" appears to have a typo. It should be "CONTRIBUTING.md" (without the extra 'G'). This is a common convention for contribution guidelines in open-source projects. Correcting this will make it easier for potential contributors to find and follow the guidelines. CONTRIBUTIONG.md [1] -# Contribution Guide +# Contributing Guide Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies a typo in the file name, which is crucial for maintaining standard conventions and ensuring contributors can easily find the guidelines. This change improves the project's professionalism and accessibility.	8
Enhancement	Add a table of contents to improve document navigation Consider adding a table of contents at the beginning of the document. This will help readers quickly navigate to specific sections of interest, especially as the contribution guide grows. You can use Markdown's built-in anchor links to create a clickable table of contents. CONTRIBUTIONG.md [1-3] -# Contribution Guide +# Contributing Guide Thank you for your interest in contributing to this project! +## Table of Contents +- [Basic Knowledge](#basic-knowledge) +- [Implementation Policy](#implementation-policy) +- [How to Develop](#how-to-develop) +- [How to Generate Pydantic Models](#how-to-generate-pydantic-models) + Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding a table of contents enhances document navigation, making it easier for contributors to locate specific sections. This is a valuable improvement for usability, especially as the document grows.	7
	Expand the development instructions to include testing, linting, and formatting In the "How to develop" section, consider adding more detailed instructions for running tests, linting, and any other development tasks. This will help ensure that contributions meet the project's quality standards and make it easier for new contributors to get started. CONTRIBUTIONG.md [47-57] ## How to develop ### Set up We utilize [Makefile](./Makefile) to set up the development environment. The subsequent command is to set up the development environment. It installs the dependencies and set up the pre-commit hooks. ```shell make setup +### Running tests + +To run the test suite, use the following command: + +shell +make test + + +### Linting + +To run the linter, use: + +shell +make lint + + +### Formatting + +To format the code, use: + +shell +make format + + - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=2 --> <details><summary>Suggestion importance[1-10]: 6</summary> Why: The suggestion to include detailed instructions for testing, linting, and formatting is beneficial for maintaining code quality and assisting new contributors. However, the exact commands may need verification to ensure they align with the project's setup. </details></details></td><td align=center>6 </td></tr><tr><td> <details><summary>Expand the contributors section with information on how to become a contributor</summary> ___ **In the "Contributors" section, consider adding a brief description of how <br>contributions are recognized and how to become a contributor. This can encourage <br>more people to contribute to the project and clarify the process for potential <br>contributors.** [README.md [282-286]](https://github.com/yu-iskw/dbt-artifacts-parser/pull/115/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R282-R286) ```diff ## Contributors -Thank you for your contributions! +Thank you for your contributions! We appreciate all the efforts to improve this project. -If you are interested in contributing to this package, please check out the [CONTRIBUTING.md](./CONTRIBUTING.md). +If you are interested in contributing to this package, please check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to get started. +Contributors are automatically recognized here when their pull requests are merged. To become a contributor: +1. Fork the repository +2. Create a new branch for your feature or bug fix +3. Make your changes and submit a pull request +4. After review and approval, your changes will be merged, and you'll be added to the list below! + Apply this suggestion Suggestion importance[1-10]: 5 Why: Providing information on how to become a contributor can encourage participation and clarify the process. While helpful, this suggestion is less critical than others, as the basic contribution link is already present.	5

💡 Need additional feedback ? start a PR chat