docs: add contributing documentation file #937
Conversation
CONTRIBUTING.md
Outdated
| @@ -0,0 +1 @@ | |||
| {{docs/development/hacking_itk_wasm.md#contributing}} | |||
There was a problem hiding this comment.
Not sure at all that this will work, especially due to referencing to a section; the file preview does not seem to be as expected:
https://github.com/InsightSoftwareConsortium/itk-wasm/blob/a51264d771371859cf0f0ab756a6d9df8b0a4795/CONTRIBUTING.md
There was a problem hiding this comment.
Since GitHub does not render it, what you think about something like,
Please see [our contributing documentation](https://wasm.itk.org/en/latest/development/hacking_itk_wasm.html) for more information.
?
There was a problem hiding this comment.
I made a few attempts in a test repository to see if the transclusion worked but did not succeed. I do not like the cross-reference solution very much, but I adopted it: instead of using the HTML link, I used a relative link directly to the section of interest in the Markdown file at issue.
Add contributing documentation file: cross-reference the contributing section of the `hacking_itk_wasm.md` file.
jhlegarreta
force-pushed
the
AddContributingDoc
branch
from
a51264d
to
0e4cce6
Compare
thewtex
merged commit 3136394
into
InsightSoftwareConsortium:main
|
🎉 This PR is included in version 1.0.0-b.140 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Add contributing documentation file: cross-reference the contributing
section of the
hacking_itk_wasm.mdfile.