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

doc: Add code reading instructions to CONTRIBUTING.md #556

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

creatorrr
Copy link
Contributor

@creatorrr creatorrr commented Oct 2, 2024

Signed-off-by: Diwank Singh Tomer [email protected]


Important

Adds detailed code reading and contributing instructions to CONTRIBUTING.md, covering project architecture, setup, and contribution guidelines.

  • Documentation:
    • Adds detailed code reading instructions to CONTRIBUTING.md.
    • Includes sections on project overview, system architecture, API specifications, core API implementation, database and storage, workflow management, testing, and additional services.
    • Provides a step-by-step guide for setting up the development environment and contributing to the project.

This description was created by Ellipsis for 4bb3e8c. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 287f3ab in 6 seconds

More details
  • Looked at 123 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. CONTRIBUTING.md:212
  • Draft comment:
    Add a newline at the end of the file for consistency and to adhere to best practices.
  • Reason this comment was not posted:
    Confidence changes required: 10%
    The new section added to CONTRIBUTING.md is comprehensive and well-structured, providing clear guidance for contributors. However, there is a minor formatting issue with the lack of a newline at the end of the file, which is a common best practice.

Workflow ID: wflow_HOB6J3gjHzH6P8YW


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@Vedantsahai18 Vedantsahai18 force-pushed the f/add-code-reading-instructions branch from 287f3ab to 4bb3e8c Compare October 2, 2024 20:40
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 4bb3e8c in 6 seconds

More details
  • Looked at 123 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. CONTRIBUTING.md:212
  • Draft comment:
    Add a newline at the end of the file for better compatibility with Unix-based systems and to adhere to best practices.
  • Reason this comment was not posted:
    Confidence changes required: 33%
    The document lacks a newline at the end of the file, which is a common best practice for text files.

Workflow ID: wflow_23pwaBm9J3IAtQAe


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@creatorrr creatorrr merged commit 866a4eb into dev Oct 2, 2024
5 checks passed
@creatorrr creatorrr deleted the f/add-code-reading-instructions branch October 2, 2024 22:11
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.

1 participant