-
-
Notifications
You must be signed in to change notification settings - Fork 28
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
Add readme command #139
base: main
Are you sure you want to change the base?
Add readme command #139
Conversation
Stil need to figure out best command and a way to fill in some of these placeholders automatically.
From slack: I think neil add readme is a reasonable choice to start with. If we need to add more we can group it under neil doc whatever later |
I'm not sure about creating a whole version update mechanism in this PR, but maybe I could add a placeholder so people who use the command now can benefit from version updates in the future. |
@alysbrooks Yeah, out of scope for this one I'd say, just a future idea |
I created #157 to document the original idea so we don't have to rely on Slack. |
No need to introduce a new subcommand.
I could autogenerate instructions for adding it as a dependency to Leiningen, Boot, and the Clojure CLI, but I'm not sure where the group id should come from |
group id comes from |
Added a command to create a project README like I proposed in Clojurians Slack.
This is a straightforward change in terms of code. The main questions are more about ergonomics and the interface rather than technical or implementation details:
docs
subcommand (like it is now) or shouldreadme
be a top-level command?add readme
was @borkdude's suggestionREADME and README templates I checked
Template
This PR corresponds to an issue with a clear problem statement : Add a command to create README #157
I have updated the CHANGELOG.md file with a description of the addressed issue.