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(repo): update "Getting started" in the README.md #668

Merged
merged 10 commits into from
Aug 22, 2023

Conversation

emredevsalot
Copy link
Collaborator

@emredevsalot emredevsalot commented Aug 18, 2023

Description

Update "Getting started" part to make it easy for newcomers to run the project on their computer.

Checklist

  • discord username: emredevsalot
  • PR must be created for an issue from issues under "In progress" column from our project board.
  • Related file selection: Only relevant files should be touched and no other files should be affected.
  • I ran npx turbo run at the root of the repository, and build was successful.
  • A descriptive and understandable title: The PR title should clearly describe the nature and purpose of the changes. The PR title should be the first thing displayed when the PR is opened. And it should follow the semantic commit rules, and should include the app/package/service name in the title. For example, a title like "docs(@kampus-apps/pano): Add README.md" can be used.
  • I installed the npm packages using npm install --save-exact <package> so my package is pinned to a specific npm version. Leave empty if no package was installed. Leave empty if no package was installed with this PR.

How were these changes tested?

Please describe the tests you did to test the changes you made. Please also specify your test configuration.

@emredevsalot emredevsalot requested a review from a team as a code owner August 18, 2023 11:32
@vercel
Copy link

vercel bot commented Aug 18, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
kampus-studio ⬜️ Ignored (Inspect) Visit Preview Aug 22, 2023 10:03am

@vercel
Copy link

vercel bot commented Aug 18, 2023

@emredevsalot is attempting to deploy a commit to the kamp-us Team on Vercel.

A member of the Team first needs to authorize it.

@emredevsalot emredevsalot requested a review from a team as a code owner August 18, 2023 21:12
Copy link
Contributor

@Ketcap Ketcap left a comment

Choose a reason for hiding this comment

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

Good start let's adjust some 👍

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Ketcap Ketcap merged commit 44d977f into kamp-us:dev Aug 22, 2023
1 check passed
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.

4 participants