Skip to content

Updating README and code of conduct - #23

Merged
jasonyang101 merged 1 commit into
mainfrom
jason/readme
Oct 30, 2025
Merged

Updating README and code of conduct#23
jasonyang101 merged 1 commit into
mainfrom
jason/readme

Conversation

@jasonyang101

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings October 30, 2025 01:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR restructures the documentation by creating dedicated CONTRIBUTING.md and CODE_OF_CONDUCT.md files, while reorganizing the README.md to improve the getting started experience. The environment setup section is moved earlier in the README to appear before users need it, and contribution guidelines are consolidated into a separate file.

Key changes:

  • Environment setup instructions moved to appear earlier in the tutorial flow
  • Contributing guidelines extracted from README into dedicated CONTRIBUTING.md file
  • New CODE_OF_CONDUCT.md file added following the Contributor Covenant 2.0

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Reorganized content by moving environment setup earlier, removing inline contributing section, simplifying enterprise contact link, and adding reference to new CONTRIBUTING.md
CONTRIBUTING.md New file consolidating all contribution guidelines including setup, workflow, commit message standards, and SDK contribution pointers
CODE_OF_CONDUCT.md New file adding Contributor Covenant 2.0 code of conduct with Scale-specific enforcement contact

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jasonyang101
jasonyang101 merged commit 8312042 into main Oct 30, 2025
2 checks passed
@jasonyang101
jasonyang101 deleted the jason/readme branch October 30, 2025 01:15
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.

3 participants