Skip to content

docs: add contribution guidelines and pull request template - #462

Merged
nightt5879 merged 4 commits into
developfrom
nightt5879/community-contribution-guidelines
Aug 5, 2026
Merged

nightt5879 merged 4 commits into
developfrom
nightt5879/community-contribution-guidelines

Conversation

@nightt5879

@nightt5879 nightt5879 commented Aug 3, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add an English contribution guide covering community language, development checks, pull request expectations, and AI-assisted contributions.
  • Add a pull request template for validation evidence, AI disclosure, and contributor responsibility.
  • Establish a lightweight and consistent contribution process for the Drawnix community.

Related Issue

None.

Validation

  • Applicable checks pass: lint, format check, tests, and build
  • Relevant E2E and manual tests are complete or not applicable

Evidence, screenshots, or compatibility notes:

  • npm run lint passed locally.
  • npm run test passed locally: 4 projects and 29 tests.
  • npm run build passed locally: 4 projects.
  • npm run format:check reported existing Windows workspace formatting differences across 128 files; neither added Markdown file was reported. The same check passed in Linux CI.
  • The main CI job passed, including lint, format check, affected tests/builds, and E2E.
  • E2E and manual product testing are not applicable to this documentation-only change.

AI Assistance

Did you use AI tools to generate or substantially modify code, tests, or documentation in this pull request?

  • No
  • Yes

If yes:

  • Tool/model: Codex / GPT-5.6 Sol

  • AI-assisted work: I used Codex to review the current repository workflow and settings and to draft and refine CONTRIBUTING.md and the pull request template based on my requirements.

  • My review and validation: I reviewed the complete contents of both documents, confirmed the policy and scope, and approved the final drafts. I also reviewed the repository commands and settings and the reported results from the local lint, tests, and builds.

  • I reviewed and understand the AI-assisted changes and can explain and maintain them

Checklist

  • The title and description are in English, and the change is focused
  • I reviewed and understand every submitted change
  • Tests, documentation, and translations were updated when needed

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

Deploying drawnix with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5669329
Status: ✅  Deploy successful!
Preview URL: https://f9c01b07.drawnix.pages.dev
Branch Preview URL: https://nightt5879-community-contrib.drawnix.pages.dev

View logs

@nightt5879

Copy link
Copy Markdown
Member Author

I accidentally clicked “Request Copilot review.” Please ignore it and any follow-up actions or comments it may generate.

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

Adds baseline community contribution documentation and a PR template to standardize expectations for development checks, PR content, and AI disclosure across the Drawnix repository.

Changes:

  • Add CONTRIBUTING.md describing community language, local dev checks, PR expectations, and AI-assisted contribution requirements.
  • Add .github/pull_request_template.md to capture summary, validation evidence, and AI disclosure consistently.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
CONTRIBUTING.md Introduces contributor workflow guidance (language, local dev checks, PR expectations, AI disclosure).
.github/pull_request_template.md Adds a PR template to standardize validation evidence and AI-assistance disclosure.

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

Comment thread CONTRIBUTING.md

@pubuzhixing8 pubuzhixing8 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.

Thanks for the contribution! This looks good overall. Approved. As a non-blocking follow-up, please consider adding a link to CONTRIBUTING.md in both README.md and README_en.md so contributors can discover the guide more easily.

@nightt5879

Copy link
Copy Markdown
Member Author

Thanks! I’ve added the CONTRIBUTING.md link to both README files. Could you take one more look? If everything looks good, I’ll merge this PR and then set up the same contribution process for Plait.

@pubuzhixing8

Copy link
Copy Markdown
Contributor

LGTM!

@nightt5879
nightt5879 merged commit b0d682c into develop Aug 5, 2026
2 checks passed
@nightt5879
nightt5879 deleted the nightt5879/community-contribution-guidelines branch August 5, 2026 08:07
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