Skip to content

docs: improve README with setup and contribution guidelines - #164

Open
k-o-c-o wants to merge 1 commit into
john-smilga:masterfrom
k-o-c-o:docs/improve-readme-117
Open

docs: improve README with setup and contribution guidelines#164
k-o-c-o wants to merge 1 commit into
john-smilga:masterfrom
k-o-c-o:docs/improve-readme-117

Conversation

@k-o-c-o

@k-o-c-o k-o-c-o commented Jul 30, 2026

Copy link
Copy Markdown

Summary

This PR improves the repository documentation by:

  • Adding local setup instructions for running individual projects
  • Documenting the repository structure (setup and final directories)
  • Adding an overview of the available npm scripts
  • Adding contribution guidelines for new contributors

Verification

The setup instructions were verified locally by running:

  • npm install
  • npm start
  • npm test

Related Issue

Closes #117

@netlify

netlify Bot commented Jul 30, 2026

Copy link
Copy Markdown

Deploy Preview for glistening-speculoos-d4f0af canceled.

Name Link
🔨 Latest commit d1a80c0
🔍 Latest deploy log https://app.netlify.com/projects/glistening-speculoos-d4f0af/deploys/6a6b876829771b000887decf

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.

Improvement in the existing markdown

1 participant