Add a static CONTRIBUTING.md template #27
Merged
Conversation
This file contains 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
The template was generated by automatically converting PyScaffold's original RST templating via [rst-to-myst] ``` rst2myst stream ~/projects/pyscaffold/src/pyscaffold/templates/contributing.template > src/pyscaffoldext/markdown/templates/contributing.template ``` and then manually adjusting the Jinja2 replacements. [rst-to-myst]: https://pypi.org/projects/rst-to-myst
Due to an [issue] the output generated by rst-to-myst does not work 100%. Therefore a fixed template seems to be a temporary solution. [issue]: executablebooks/rst-to-myst#33
For some reason Jinja2 substitutions don't seem to work when rendering the markdown templates even when the myst extension is active. This change improves the template having that concern in mind.
abravalheri
changed the title
|
Thanks @abravalheri! I think that's perfect for the time being and the implementation is much easier. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is an alternative implementation to address #18, while the issues with rst-to-myst still persist.
The template was generated by automatically converting PyScaffold's original RST templating via rst-to-myst CLI and then manually adjusting/improving it.
For some mysterious reason, I did not manage to make Jinja2 substitutions even when the
substitutionmyst extension is active inconf.py(which is very curious because it is working fine in the example I create when I opened the issue inrst-to-myst- see expected_option1.md)The code in this PR is based on #25.