Skip to content

Add prerequisites for project setup#289

Closed
jnakaigen wants to merge 1 commit into
CCExtractor:mainfrom
jnakaigen:patch-2
Closed

Add prerequisites for project setup#289
jnakaigen wants to merge 1 commit into
CCExtractor:mainfrom
jnakaigen:patch-2

Conversation

@jnakaigen
Copy link
Copy Markdown

Description

This PR improves the Development Setup documentation by adding a clear Prerequisites section.

Changes made:

  1. Added Prerequisites List: Explicitly listed the required tools (Go, Node.js) and optional tools (Docker, Tmux) needed to run the project. This helps new contributors avoid "command not found" errors during initial setup.
  2. Added Windows Warning: Added a note clarification that the setup.sh script (which uses tmux) is intended for Linux/macOS, and directed Windows users to follow the Manual Setup instructions instead.
  • Fixes: N/A (Documentation improvement)

Checklist

  • Ran npx prettier --write . (for formatting)
  • Ran gofmt -w . (for Go backend)
  • Ran npm test (for JS/TS testing)
  • Added unit tests, if applicable
  • Verified all tests pass
  • Updated documentation, if needed

Additional Notes

These changes were motivated by my own experience setting up the project on Windows. Clarifying the prerequisites upfront will streamline the onboarding process for future Windows contributors.

Added prerequisites section with installation requirements for Go, Node.js, Docker, and Tmux.
@github-actions
Copy link
Copy Markdown

Thank you for opening this PR!

Before a maintainer takes a look, it would be really helpful if you could walk through your changes using GitHub's review tools.

Please take a moment to:

  • Check the "Files changed" tab
  • Leave comments on any lines for functions, comments, etc. that are important, non-obvious, or may need attention
  • Clarify decisions you made or areas you might be unsure about and/or any future updates being considered.
  • Finally, submit all the comments!

More information on how to conduct a self review:
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request

This helps make the review process smoother and gives us a clearer understanding of your thought process.

Once you've added your self-review, we'll continue from our side. Thank you!

@its-me-abhishek its-me-abhishek added invalid This doesn't seem right wontfix This will not be worked on labels Dec 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

invalid This doesn't seem right wontfix This will not be worked on

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants