Skip to content

Add CONTRIBUTING.md - #66

Merged
hzhangxyz merged 3 commits into
mainfrom
copilot/add-contributing-md-file
Dec 6, 2025
Merged

Add CONTRIBUTING.md#66
hzhangxyz merged 3 commits into
mainfrom
copilot/add-contributing-md-file

Conversation

Copilot AI commented Dec 6, 2025

Copy link
Copy Markdown
Contributor
  • Create CONTRIBUTING.md file based on project documentation and README
  • Include sections for:
    • Getting started with the project
    • Development environment setup (for C++, Python, TypeScript)
    • Code style guidelines (clang-format, ruff, Biome)
    • Pre-commit hooks
    • Running tests
    • Submitting pull requests
    • License information
  • Run code review
  • Run CodeQL security check
  • Address feedback: add welcome message for issues/PRs
  • Address feedback: simplify PR submission guidelines
Original prompt

This section details on the original issue you should resolve

<issue_title>需要一个contributing.md</issue_title>
<issue_description></issue_description>

<agent_instructions>请参考docs和readme,以及项目描述文件等信息</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Copilot AI changed the title [WIP] Add contributing.md for contribution guidelines Add CONTRIBUTING.md Dec 6, 2025
Copilot AI requested a review from hzhangxyz December 6, 2025 02:44
@hzhangxyz
hzhangxyz marked this pull request as ready for review December 6, 2025 02:44
Copilot AI review requested due to automatic review settings December 6, 2025 02:44

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 adds a comprehensive CONTRIBUTING.md file to provide clear guidelines for contributors. The file is well-structured and accurately reflects the project's existing documentation, configuration files, and development practices.

  • Establishes a complete contribution workflow from forking/cloning through PR submission
  • Documents build instructions for all three language bindings (C++, Python, TypeScript/JavaScript) with correct version requirements
  • Specifies code style tools and pre-commit hooks that match actual project configuration

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

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  1. 你在前面需要欢迎issue和pr一下
  2. Submitting Pull Requests那里,不要太多强制,大概建个branch(名字合理即可不用强制feature/xxx)然后介绍也不要强制一定包含什么

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Dec 6, 2025

Copy link
Copy Markdown
Contributor Author
  1. 你在前面需要欢迎issue和pr一下
  2. Submitting Pull Requests那里,不要太多强制,大概建个branch(名字合理即可不用强制feature/xxx)然后介绍也不要强制一定�...

Done in 53aa36c. Added "We welcome issues and pull requests from everyone." at the beginning, and simplified the PR submission section to remove forced branch naming and strict content requirements.

@hzhangxyz
hzhangxyz merged commit d03c84a into main Dec 6, 2025
51 checks passed
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.

需要一个contributing.md

3 participants