Skip to content

Latest commit

 

History

History
89 lines (51 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

89 lines (51 loc) · 4.16 KB
Raw

Contributing

The Open Source Guides website has a collection of resources for individuals, communities, and companies. These resources help people who want to learn how to run and contribute to open source projects. Contributors and people new to open source alike will find the following guides especially useful:

Get involved

There are many ways to contribute to Sveltepress, and many of them do not involve writing any code. Here's a few ideas to get started:

  • Simply start using sveltepress. Go through Quick start guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
  • Look through the open issues. A good starting point would be issues tagged good first issue. Provide workarounds, ask for clarification, or suggest labels. Help triage issues.
  • If you find an issue you would like to fix, open a pull request.
  • Read through the docs site. If you find anything that is confusing or can be improved, you can make edits by clicking "Suggest changes to this page" at the bottom of the page.

Bugs

We use GitHub issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a bug report.

Pull requests

Proposing a change

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with feature template.

If you're only fixing a bug, it's fine to submit a pull request right away, but we still recommend that you file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Small pull requests are much easier to review and more likely to get merged.

Creating a branch

Fork the repository and create your branch from master. If you've never sent a GitHub pull request before, you can learn how from this free video series.

Installation

  • Make sure you have PNPM and Node > 16 installed
  • Run pnpm install in the project root

Testing

Use Vitest for testing.

All tests are located in packages/[package name]/__test__ folder.

To run test, run pnpm test in the package root.

Develop docs site

  • run cd packages/docs-site
  • run pnpm dev
  • Open the address in the terminal to see local started docs site

Develop vite plugin package

Please provide test cases if possible

If you've changed APIs, update the documentation.

Develop default theme package

Please provide test cases if possible

If you've changed APIs, update the documentation.

If you've changed UI components. Provide screenshots about before and after changes made.

Style guide

Lint

Use Eslint and Prettier to restrict the format of codes.

  • If a js or a ts file changed, use eslint to check it.
  • If a svelte file changed, use eslint and prettier to check it.

Naming convention

  • Svelte component filename in CamelCase
  • js and ts filename in kebab-case
  • function and variable name in camelCase

Submitting pull requests

  • Make sure pnpm lint ran and no error were found.
  • Make sure pnpm test ran in the package changes made and no error were found.
  • If a version update is considered required. Welcome using Changesets by running npx changesets to add one in pull request.

Looking forward to contributions in any forms .