Move style guide to wiki #4703
Move style guide to wiki #4703
Conversation
newhoggy
requested review from
a team,
dcoutts,
Jimbo4350,
erikd,
JaredCorduan,
LudvikGalois and
CarlosLopezDeLara
as code owners
README.rst
Outdated
| **** | ||
| Style guide | ||
| **** | ||
|
|
||
| The `style guide <https://github.com/input-output-hk/cardano-node/wiki/Style-guide>` for can be found in the wiki. | ||
|
|
There was a problem hiding this comment.
I would like that plutus, ouroboros-network, the future ouroboros-consensus and cardano-ledger are consistent in where style guide can be found.
plutus:STYLEGUIDE.docsouroboros-network:docs/StyleGuide.mdouroboros-consensus(insideouroboros-networkrepo):ouroboros-consensus/docs/StyleGuide.mdcardano-node: a wiki.
I would rather like to move the wiki page to STYLEGUIDE.md or at least put the link in the STYLEGUIDE.md document.
There was a problem hiding this comment.
The problem with docs/StyleGuide.md is we already have a doc directory (ie. no s). I'm not sure what the impact of renaming the directory is.
Would it suffice to rename STYLE.md to STYLEGUIDE.md?
There was a problem hiding this comment.
Yes, I'd use /STYLEGUIDE.md; I plan do the same in ouroboros-network repo once ouroboros-consensus* migrates to its own repo.
README.rst
Outdated
| Style guide | ||
| **** | ||
|
|
||
| The `style guide <https://github.com/input-output-hk/cardano-node/wiki/Style-guide>` for can be found in the wiki. |
There was a problem hiding this comment.
Added the reference to cardano-node.
newhoggy
force-pushed
the
newhoggy/move-style-guide-to-wiki
branch
2 times, most recently
from
902938d
to
7352a57
Compare
newhoggy
force-pushed
the
newhoggy/move-style-guide-to-wiki
branch
from
7352a57
to
6dad6ab
Compare
No description provided.