Fix the file name of CONTRIBUTING.md

[yu-iskw]

PR Type

documentation

---

Description

• Added a new CONTRIBUTING.md file with a detailed guide for contributors.
• The guide includes basic knowledge about the project, focusing on generating Pydantic models from dbt artifacts.
• Outlined the implementation policy to ensure consistency and maintainability.
• Provided instructions for setting up the development environment using a Makefile.
• Detailed the process for generating Pydantic models from JSON schemas of dbt artifacts.

---

Changes walkthrough 📝

	Relevant files
Documentation	CONTRIBUTING.md Add comprehensive contribution guide for the project          CONTRIBUTING.md Added a comprehensive contribution guide. Included sections on basic knowledge and implementation policy. Provided setup instructions for the development environment. Explained steps to generate Pydantic models from dbt artifacts. +71/-1

---

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

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)

• CONTRIBUTING.md

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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 Minor Typo There's a minor typo in the word "subsequent" on line 52. Clarity Improvement The section on generating Pydantic models could benefit from more specific instructions or a code example.

[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	Add a section on testing to guide contributors on running and writing tests Consider adding a "Testing" section to explain how to run tests and what kind of tests are expected when contributing new code. This would help ensure code quality and consistency across contributions. CONTRIBUTING.md [47-59] ## 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 +### Testing + +We use pytest for our test suite. To run the tests, use the following command: + +shell +make test + + +When contributing new code, please ensure that you add appropriate tests and that all tests pass before submitting a pull request. + How to generate Pydantic models - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: Including a testing section is crucial for maintaining code quality and consistency across contributions. It ensures that contributors understand the testing framework and requirements, which is essential for a robust codebase. </details></details></td><td align=center>8 </td></tr><tr><td> <details><summary>Add a section on code style to maintain consistency across contributions</summary> ___ **Consider adding a "Code Style" section to outline the coding conventions and style <br>guidelines for the project. This would help maintain consistency across <br>contributions and make the codebase more readable.** [CONTRIBUTING.md [47-59]](https://github.com/yu-iskw/dbt-artifacts-parser/pull/117/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R47-R59) ```diff ## 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 +### Code Style + +We follow PEP 8 style guide for Python code. Please ensure your code adheres to these standards. We use tools like flake8 and black to maintain code quality. You can run the following command to check your code style: + +shell +make lint + + How to generate Pydantic models - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=1 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: A code style section helps maintain consistency and readability across the codebase. By outlining coding conventions and using tools like flake8 and black, contributors can ensure their code adheres to project standards, enhancing overall code quality. </details></details></td><td align=center>8 </td></tr><tr><td rowspan=1><strong>Enhancement</strong></td> <td> <details><summary>Add a section on how to submit a pull request to provide clear guidance for contributors</summary> ___ **Consider adding a section about how to submit a pull request. This would provide <br>clear guidance for contributors on the process of submitting their changes, <br>including any specific requirements or conventions for this project.** [CONTRIBUTING.md [47-59]](https://github.com/yu-iskw/dbt-artifacts-parser/pull/117/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R47-R59) ```diff ## 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 +### Submitting a Pull Request + +1. Fork the repository and create your branch from main. +2. If you've added code that should be tested, add tests. +3. Ensure the test suite passes. +4. Make sure your code lints. +5. Issue that pull request! + +For more detailed information, please see our Pull Request Template. + How to generate Pydantic models - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=2 --> <details><summary>Suggestion importance[1-10]: 7</summary> Why: Adding a section on how to submit a pull request would provide clear guidance for contributors, ensuring a smoother contribution process and maintaining consistency in submissions. This is a valuable addition to the contribution guide. </details></details></td><td align=center>7 </td></tr></tr></tbody></table> >💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)