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

Added documentation to CONTRIBUTING.md file #569

Closed
wants to merge 4 commits into from

Conversation

PRIYANKjakharia
Copy link

@PRIYANKjakharia PRIYANKjakharia commented Oct 2, 2024

fixes improvisation on issue #554

  • Information about project components, including agents, workflows, activities, and database
  • Code style guidelines, including indentation, line length, and variable naming
  • Testing information, including unit tests, integration tests, and end-to-end tests

This commit adds important documentation to the CONTRIBUTING.md file, making it easier for new contributors to understand the project and get started.


Important

Enhances CONTRIBUTING.md with comprehensive documentation on project components, code style, testing, and contribution guidelines.

  • Documentation:
    • Adds detailed sections on project components, including agents, workflows, activities, and database.
    • Includes code style guidelines: 4-space indentation, 80-character line length, camelCase variable naming.
    • Provides testing information: unit tests, integration tests, end-to-end tests.
  • Contribution Process:
    • Describes steps for forking, branching, making changes, and submitting pull requests.
    • Outlines setup instructions, including environment variables and Docker setup.
    • Details project overview, architecture, and technology stack.
    • Provides guidelines for understanding the codebase and contributing effectively.

This description was created by Ellipsis for 8b0ec3c. 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 8b0ec3c in 6 seconds

More details
  • Looked at 157 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. CONTRIBUTING.md:246
  • Draft comment:
    Add a newline at the end of the file for better compatibility with various text editors and version control systems.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The document is missing a newline at the end of the file, which is a common best practice for text files.

Workflow ID: wflow_tYZjRwiaidjLHFYx


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

@creatorrr
Copy link
Contributor

@PRIYANKjakharia there is a lot of redundancies and duplication in this PR because the CONTRIBUTING.md file has been updated since you started this. Can you re-review (prefer manually and not via chatgpt) and remove duplicated info and reorganize for readability?

@PRIYANKjakharia PRIYANKjakharia closed this by deleting the head repository Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants