python / python/python-insider-blog
README instructions for writing blog entries do not work as-is
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 32
- Forks
- 12
- Avg merge
- 9h 37m
- Merged PRs (30d)
- 9
Description
The README currently says:
You can pull the repo, run
make dev, and edit the page via Keystatic with the nice UI
I did so, and noticed that this had an implicit dependency on Bun. This dependency should be called out.
After installing Bun, I got a different failure due to the astro not being installed:
❯ make dev
bun run dev
$ astro dev
/bin/bash: astro: command not found
error: script "dev" exited with code 127
make: *** [dev] Error 127
This is because, the user needs to do a make install before make dev.
I did end up writing it in Markdown, since I'm familiar with that.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update the README instructions for writing blog entries. Verify the documented setup by checking the make dev and make install workflow, then state that Bun is required and that make install must run before make dev; done means a new contributor can follow the instructions without encountering the reported errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bun
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100