matic-docs icon indicating copy to clipboard operation
matic-docs copied to clipboard

matic-docs/docs/contribute/contributor-guidelines.md

Open Arrowaaa opened this issue 1 year ago • 0 comments

Modified the content of this page to provide a clear and concise guide on how to contribute to the Polygon documentation as part of the application process for the role of Technical Writer. This assignment can't be copied or reused.

Comments/questions:

  • This page is a merge of the content found both on Update /docs/develop/README.md and matic-docs/docs/contribute/contributor-guidelines.md
  • The guidelines listed on the Polygon Style Guide are mostly based on Plain English guidelines, which allow the use of "we". This is not the case in your guide. I've ignored this rule on purpose to avoid the use of the passive voice and to add a friendlier tone.
  • If you agree with the edits on this page, it would be interesting to add screenshots or gifs.
  • The Git rules section of this page weren't very clear to me and would benefit from extra edits to clarify them. In a work context, I would have asked for more information and examples.
  • I would be interested in knowing the level of knowledge of Github most of your contributors have so that we can edit this article accordingly. Currently we assume they have a relatively good knowledge of GitHub, but if that's not the case we might want to emphasize on how to edit articles through the Wiki rather than a local copy.

Arrowaaa avatar Jul 10 '22 17:07 Arrowaaa