-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Default README format to Markdown in "new" (#280) #1515
Default README format to Markdown in "new" (#280) #1515
Conversation
**NEW** * A new parameter called `--readme` for `poetry new` is introduced, which used for defining the README format. This can be set either to `md` or `rst` * The readme is included in the `pyproject.toml` **CHANGE** * The default README format is now `.md` **FIX** * Test for `poetry new` is added
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution @finswimmer! 🍡 💫
The PR looks good to me with two small comments but these aren't blockers necessarily for merging. @sdispater what do you think of having Markdown as the default readme format?
The isort check is new, isn't it? This would change > 100 files. Should I really do this? |
Any updates? |
8a70d79
to
6fa062c
Compare
809d397
to
2be6781
Compare
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
Closing this in favour of #2768. @finswimmer @stephsamson can we get that one approved? This change is included there. |
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
Hi! First many thanks for that tool! From above, will README.md with In fact I'd like to be able to control getting a Markdown Thank you, |
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: python-poetry#280 Closes: python-poetry#1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
This change makes readme formant configurable, defaulting to markdown when using the new command. Resolves: #280 Closes: #1515 Co-authored-by: Arun Babu Neelicattu <[email protected]>
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This PR implements #280.
NEW
--readme
forpoetry new
is introduced, which used for defining the README format. This can be set either tomd
orrst
pyproject.toml
CHANGE
.md
FIX
poetry new
is addedPull Request Check List
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!
Note: If your Pull Request introduces a new feature or changes the current behavior, it should be based
on the
develop
branch. If it's a bug fix or only a documentation update, it should be based on themaster
branch.If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!