search

ethereum / portal-network-specs

Official repository for specifications for the Portal Network
313 stars 85 forks source link

[FIX] Improve writing problems + fix several typos #332

Open azarpoor opened 2 months ago

azarpoor commented 2 months ago

@kdeme @ogenev :hand:

azarpoor commented 2 months ago

@kdeme

azarpoor commented 2 months ago

Great, thanks for fixing typos, removing trailing whitespaces, fixing notes.

But regarding list styles, indents, emphasis markers and so on (anything that does not break markdown specs), that seems like personal preference changes that are also difficult to maintain without having a linter applied in CI.

So in my opinion, these type of changes should get a linter added first for some consistent settings, else somebody else tomorrow might just set them all back to their liking.

correct :+1:

do we have a general linter for repo? if we dont have a proper linter for repo we can implement a structure for this one

kdeme commented 2 months ago

do we have a general linter for repo? if we dont have a proper linter for repo we can implement a structure for this one

No, we don't. I've created an issue for this some time back: https://github.com/ethereum/portal-network-specs/issues/321

My suggestion would be to adjust this PR to only contain actual fixes.

Any additional PR that then introduces linting is highly welcomed of course :)

azarpoor commented 2 months ago

do we have a general linter for repo? if we dont have a proper linter for repo we can implement a structure for this one

No, we don't. I've created an issue for this some time back: #321

My suggestion would be to adjust this PR to only contain actual fixes.

Any additional PR that then introduces linting is highly welcomed of course :)

nice !

yeah of course , i will change necessary changes on this pull req :+1:

and yeah i enjoy giving structural improve :)) i try my best for making another pull req for linting purpose :+1: