-
-
Notifications
You must be signed in to change notification settings - Fork 26
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
TroyKomodo
merged 3 commits into
ScuffleTV:feature/website
from
chipsTM:update-contributing
Feb 2, 2024
Merged
docs: add details about dev env setup #206
TroyKomodo
merged 3 commits into
ScuffleTV:feature/website
from
chipsTM:update-contributing
Feb 2, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lennartkloock
requested changes
Jan 31, 2024
CONTRIBUTING.md
Outdated
|
||
### Website | ||
|
||
The website uses vite + svelte and uses npm to run in dev mode |
There was a problem hiding this comment.
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
.
lennartkloock
approved these changes
Jan 31, 2024
TroyKomodo
reviewed
Jan 31, 2024
CONTRIBUTING.md
Outdated
|
||
Create a local/platform-api-config.toml | ||
|
||
You will need to generate organization id and access token via the video-cli |
There was a problem hiding this comment.
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
approved these changes
Jan 31, 2024
SputNikPlop
approved these changes
Feb 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 applyChecklist
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.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.