Document development setup prerequisites - #108
Draft
sueun-dev wants to merge 1 commit into
Draft
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
make pypistatsruns the Docker Compose flow from the MakefileContext
The current README tells contributors to run
make pypistats, and the Makefile target invokesdocker-compose down,docker-compose build, anddocker-compose up. This makes the expected Docker, Docker Compose, and Make prerequisites explicit before a first-time contributor runs the command.Closes #98.
Test Plan
git diff --checkREADME.rstwithdocutils.core.publish_doctreeI also checked the local setup boundary: on a machine without
docker-compose,make pypistatsfails immediately atdocker-compose down, which matches the prerequisite documented here.