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.

Sign up for GitHub

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

Jump to bottom

Create a CONTRIBUTING.md guide #362

Open
AdrianGonz97 opened this issue Dec 16, 2024 · 2 comments
Open

Create a CONTRIBUTING.md guide #362

AdrianGonz97 opened this issue Dec 16, 2024 · 2 comments

Comments

@AdrianGonz97
Copy link
Member

It's not immediately obvious how someone could start contributing to this project, so we'll want to create a helpful guide to get people started.

At the very minimum, it should cover:

  • building/running in dev
  • how to test the cli locally
  • how to run and write tests
  • some style guidelines and code conventions

As an additional reference, here's the current CONTRIBUTING.md guide for Svelte
@benmccann
Copy link
Member

Last I recall, the SvelteKit contributing guide might be a better one to follow though I haven't compared them lately

@manuel3108
Copy link
Member

We might also be able to take some inspiration from svelte-add

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@benmccann @manuel3108 @AdrianGonz97