search

electron-forge / electron-forge-docs

:electron: Mirror for Electron Forge's GitBook documentation
https://electronforge.io
83 stars 146 forks source link

docs: lint & format #121

Closed PhentomPT closed 1 year ago

PhentomPT commented 1 year ago

Please review 🧐 @malept @VerteDinde @erickzhao

Partial from PR #116

Changes :sparkles:

PhentomPT commented 1 year ago

Hey @PhentomPT, thanks for the PR. I wanted to ask: how did you determine the lint rules to use for this diff?

I'm asking because we don't have any lint rules set up, and generally follow the lint that is enforced through the GitBook platform.

If any of the formatting changes you submitted conflict with GitBook's own linting, it will revert your changes next time a maintainer edits via their WSIWYG editor.

🤔 Interesting... these changes where auto applied from vscode prettier/eslint on save What is your opinion on adding eslint/prettier files to the repo so that outside contributions can all follow the same structure? Or maybe its easier to make the gitbook public but with restrictions? (i don't know if this one is possible)

erickzhao commented 1 year ago

I think it's hard to enforce our own structures for formatting to follow GitBook's. In any case, I think #103 addresses some of these changes using markdownlint while hopefully not colliding with any GitBook rules.