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

docs: update contributing guidelines #10926

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

goffxnca
Copy link
Contributor

@goffxnca goffxnca commented Nov 7, 2024

  • Added middlewares roles in the project structure.
  • Updated test instructions, pnpm test script is no longer available on root package.json.
  • Removed duplicate “A good bug report...” line.
image

PR-Codex overview

This PR updates the CONTRIBUTING.md file to improve clarity on project structure and testing procedures, including new sections on middleware and enhanced testing commands.

Detailed summary

  • Changed context to contexts in project structure description.
  • Added a section for middlewares, detailing their purpose.
  • Expanded testing instructions to include:
    • pnpm test:ci for overall unit tests.
    • pnpm test:config for configuration changes verification.
    • pnpm e2e:ci for end-to-end testing.
  • Added a note about automatic tests during PRs.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Nov 7, 2024

⚠️ No Changeset found

Latest commit: 025abd9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
uikit ⬜️ Ignored (Inspect) Visit Preview Nov 7, 2024 7:16pm

Copy link

vercel bot commented Nov 7, 2024

@goffxnca is attempting to deploy a commit to the PancakeSwap Team on Vercel.

A member of the Team first needs to authorize it.

@goffxnca goffxnca changed the title Docs/update contributing guidelines docs: update contributing guidelines Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant