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: add details about dev env setup #206

Merged
merged 3 commits into from
Feb 2, 2024

Conversation

chipsTM
Copy link
Contributor

@chipsTM chipsTM commented Jan 31, 2024

Proposed changes

Add more clarity to the Contributing docs about the development environment to allow contributors to get started more easily

Types of changes

What types of changes does your code introduce to Scuffle?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, you may want to start the discussion by explaining why you chose the solution you did, what alternatives you considered, etc.

@chipsTM chipsTM requested a review from a team as a code owner January 31, 2024 02:08
@CLAassistant
Copy link

CLAassistant commented Jan 31, 2024

CLA assistant check
All committers have signed the CLA.

CONTRIBUTING.md Outdated

### Website

The website uses vite + svelte and uses npm to run in dev mode
Copy link
Member

Choose a reason for hiding this comment

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

We try to avoid using npm. Instead use pnpm.

CONTRIBUTING.md Outdated

Create a local/platform-api-config.toml

You will need to generate organization id and access token via the video-cli
Copy link
Member

Choose a reason for hiding this comment

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

perhaps include the commands to generate these?

@TroyKomodo TroyKomodo merged commit 78bfbb2 into ScuffleTV:feature/website Feb 2, 2024
4 of 6 checks passed
@chipsTM chipsTM deleted the update-contributing branch February 12, 2024 06:24
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.

5 participants