Skip to content

docs: add contributing guide - #51

Open
dreyfus92 wants to merge 1 commit into
mainfrom
docs/contributing
Open

dreyfus92 wants to merge 1 commit into
mainfrom
docs/contributing

Conversation

@dreyfus92

Copy link
Copy Markdown
Member

What does this PR do?

adds a contributing guide

Closes #50

Type of change

  • Bug fix
  • Feature
  • Refactor (no behavior change)
  • Documentation
  • Performance improvement
  • Tests
  • Chore (dependencies, CI, tooling)

Checklist

  • All tests pass (pnpm test)
  • Files are formatted (pnpm format)
  • I have added/updated tests for my changes (if applicable)
  • I have added a changeset

AI-generated code disclosure

  • This PR includes AI-generated code

@trueberryless trueberryless left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great to me. I just left a small thought for further possible improvements for convenience, but no blocker

Comment thread CONTRIBUTING.md
| ------------------------------------------ | ----------------------------------------- |
| `pnpm test` | Runs every test |
| `pnpm test packages/ui/src/layout.test.ts` | Runs one test file |
| `pnpm lint` | Runs the linter |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Might be convenient to add a pnpm lint:check command, or to keep it consistent with the format naming convention, let lint check and add a lint:fix command.

And another command I have seen in some projects that is pretty convenient is a check:all command, which runs build, format, lint, unit tests. Wdyt? Could be a follow up PR

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.

Add CONTRIBUTING.md

2 participants