7 Commits

Author SHA1 Message Date
Fatuma Abdullahi
103a4c96e4 fix: update good first issue link (#23464)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2024-08-23 09:05:50 +00:00
daedalus
6324cd4e3f docs: add changeset generate command and version bump type explanations (#20244)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-10-29 23:28:12 +00:00
Rijk van Zanten
f0067dc61a Update pull-request-process.md 2023-10-04 14:39:04 -04:00
Connor
92621429ee Linting and Formatting Upgrade (#18892)
* add docs to eslint

* update prettier ignore

* fix vitepress linting

* eslint ignore fixes

* prettier run

* update prettier ignore

* fix formatting

* enable linting of markdown files

* revert format command change

* fix irregular whitespace

* update dictionary

* (Changelog) Create four-boxes-shake.md

* Rework ESLint / Prettier setup

- Disable js/ts/vue files for Prettier to ensure linting/formatting is
  only happening via ESLint
- Rework formatting of code blocks in md files
  - Disable formatting of code blocks in md files under '/docs' by Prettier
  - Instead use "eslint-plugin-markdown" to format & __lint__ js*/ts*/vue such code blocks
  - Replace unmaintained "eslint-plugin-md" plugin by official "eslint-plugin-markdown" plugin
  - I'll check whether we can use this to format other code blocks
    (json, html, ...) as well
- Restructure, clean-up and apply some fixes to the ESLint config
  (Note: Not ready for flat config yet since not supported by
  vscode-eslint)
- Enable cache for ESLint / Prettier in scripts
- Clean-up ignore file
  - Explicit folder declaration (.../)
  - Don't ignore all 'extensions' folders in ESLint (only
    '/api/extensions/')
  - Enable formatting in '/.github' folder

* Fix all formatting issues with Prettier

* Update md files under /docs/.typedocs

* Fix lint issues in vue/js files

* ESLint / Prettier config revision v2

Enable Prettier for md code blocks, but only as warnings since it can
get into the way with Vitepress md extensions like '[!code ...]'
comments

* Remove prettier-ignore comments

* Make spellchecker happy

* Remove changeset

* Revert lint setup for code blocks

There are many cases in the docs where linting / formatting of code
blocks doesn't make
sense:
- Code block is only an excerpt - linter fails
- Code block contains special comments (e.g. markdown extensions) which
  needs to remain at the same place - formatting would break it
- ...

* Apply lint issues / formatting from temp lint setup

* Run formatter

* Fix merge failure

* Simplify & modernize ESLint / Prettier setup

No longer run Prettier via ESLint. Nowadays, this is the recommended
setup. There's no real need to run it this way, it's just an additional
layer.

Add VS Code settings to make the work with the new setup easier.

* Remove unused eslint disable directives

* Make editorconfig more useful

* Fix formatting issues reported by editorconfig

* Format files with Prettier

* Enable formatting of source translations file

* Format source translations file

* Remove unnecessary console error

* Remove unnecessary line

* Only ignore md files under .changeset

* Add CI reporter for Prettier

* Fail job on wrongly formatted files

* Fix format

* Test Prettier action on changed/added file

* Use simple CI format check for now & no cache

* Revert "Test Prettier action on changed/added file"

This reverts commit 4f7d8826ad.

* Introduce code blocks check for docs

* Fix code block issues

* Ignore auto-generated packages dir

* Fix comment position

* Also lint `/app/.storybook`

* Reformat modified files

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-06-29 11:54:01 +02:00
Connor
f667fe7658 Contributor Docs Improvements Round 2 (#18667)
* add delete by query information and examples

* add that changelogs should be past tense

* add examples of unit and blackbox tests

* add information on where upload/extension folder should go locally

* add new packages and remove redundant column

* fix spelling

* Create hot-pillows-tan.md

* Fix tip box and links

* Update docs/contributing/codebase-overview.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/running-locally.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-30 12:30:58 -04:00
Connor
b67c4cd2e2 Contributor Docs Improvements Round 1 (#18545)
* Move Debug Docs from Wiki to Docs

* Add Copyright License Agreement to Docs

* Start Reformat0 of Codebase Overview

* Add Package Documentation to Codebase Overview

* Add Link to Blackbox Folder

* Add Changesets to Pull Request Process

* Add Component Library Tips

* Fix Spelling

* Fix dictionary

* Create thick-glasses-bake.md

---------

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-05-12 09:29:00 -04:00
Rijk van Zanten
5cf2c0d724 Add feature request workflow to contributing guidelines (#18528)
* Point to docs hosted C&C

* Point to hosted contributing guidelines

* Remove outdated information

This is incorrect, so does more harm than good imo

* Update contributing guidelines to add feature requests flow

* Lil nicer to read

* Add missing words to dict

* Update docs/contributing/code-of-conduct.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/introduction.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/pull-request-process.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/feature-request-process.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/feature-request-process.md

Co-authored-by: Kevin Lewis <kvn@lws.io>

* Update docs/contributing/pull-request-process.md

Co-authored-by: Kevin Lewis <kvn@lws.io>

* Fix license/version for new packages (#18536)

* Standardize TSConfig use (#18538)

* Use tsconfig.prod.json in packages

* Use prod tsconfig in api

* Install node types in storage

* Use vitest run instead of --watch=false (#18540)

* Remove local file

* Revert "Use vitest run instead of --watch=false (#18540)" (#18542)

This reverts commit 97f0af669e.

* Setup boilerplate for data (#18541)

* Setup boilerplate for data

* Update readme

* Fix directory link

* Final tweaks from Ben

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Kevin Lewis <kvn@lws.io>
2023-05-10 15:22:57 -04:00