Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 4.66 KB

CONTRIBUTING.md

File metadata and controls

84 lines (53 loc) · 4.66 KB

Contributing

Thank you for your interest in contributing to SolidStart. We welcome contributions including bug fixes, feature enhancements, documentation improvements, and more.

Creating a Template

We do not maintain official templates and integrations in this monorepo. Instead, please head over to solidjs/templates to submit your contribution.

Documentation

We always want help and creative ways of explaining how to take the best out of SolidStart. Alas, this is not the right place to do it, please head over to SolidDocs and contribute to the official documentation!

Feature Request

Important

Do not create a PR without prior discussion in an issue

If there's a new feature you'd like to request you can:

  1. Create an issue and make your pitch. Be sure to explain the value proposition in a way that will benefit most users.

  2. If it's a more general concept, feel free to open a Discussion in the Idea category.

A new primitive follows the same criteria as issues, please create an issue for it to be discussed beforehand.

Primitives that depend on multiple external dependencies and 3rd party integrations are generally not a good fit to live inside this monorepo, we still welcome you to create it and share with the ecosystem. Reach out in a Discussion in the showcase section and we'll amplify as much as we can!

Found a Bug

If you believe you found a bug, we appreciate you creating an issue. Issues without a reproduction or PR link will be automatically closed.

To speed up triaging, we recommend 2 strategies:

Minimal Reproduction

Create a minimal reproduction either in a remote IDE or in an open-source repository and add a link to your issue.

We recommend using the create-solid package with the basic setting.

Package Manager Command
pnpm pnpm create solid@latest -st basic
npm npm create solid@latest -- -st basic
yarn yarn create solid -st basic
bun bun create solid@latest --s --t basic
deno deno run -A npm:create-solid -st basic

Failing Test PR

You can also fork this repository and go to apps/tests. There we have an app with all default configurations and many routes. Create a new route, a Vitest or Playwright assertion (as appropriate) to it and open a PR with the failing test-case.

Once the PR is there, create an issue and link the PR (mention the PR as you'd mention a person in the issue description and vice versa).

On testing
  • If what you'd like to change needs e2e testing (i.e. you need a working build to test your feature), use playwright (see the /app/tests/e2e directory for examples).
  • If what you'd like to change is specific to a component, function (i.e. you need a unit test), use Vitest. You can find examples in the /app/tests/ directory, look for the .tests.ts/.test.tsx files.
    • Note: Vitest is also set-up to test individual components - have a look at /app/tests/routes/(basic).browser.test.tsx for an example.

Testing conventions:

  • For e2e test, simply place them in the apps/tests/e2e directory. The project is configured to run anything found in that directory via playwright as an e2e test.
  • For unit tests, co-locate them in the same place as the component or function they test:
    • E.g. If you're testing /app/tests/MyComponent.tsx, create a file named /app/tests/MyComponent.test.browser.tsx in the same directory. Note the .browser part - that's important to tell Vitest that this test should run in a browser environment.
    • For server-side unit tests, use the same placement conventions as described for components, but create a file named /app/tests/myfeature.test.server.ts in the same directory. Using .server in the filename tells Vitest that this test should run in a node environment.

Important

Mark the allow edit by the maintainers so we can more easily investigate the failing test and propose a fix. Otherwise we may need to close your PR and cherry-pick your commit.

Formatting your code

We have a set of rules defined in the .editorconfig and .oxfmtrc.json files. Please format your code before opening a PR, so that we keep the codebase consistent. Regardless of what editor you use, running pnpm format will format your code according to our rules.

If you have read all the way here, you're already a champ! 🏆 Thank you.