Aveline-art
commented
2 years ago Questions for all team:
- Do we need a fallback font, or even several? For context, cases where a fallback font is needed are:
- Our font fails to load. This risk is, I am assuming, minimal since our font is delivered via our client, rather than through CDN. This means that in normal cases, if our font fails to load, it means our website is down. Another possibility could be a very specific bug in the code, which should be caught at the code review stage.
- Our font does not contain a unicode for a specific character. For example, if our font does not contain an umlaut Ä, the Chinese 李 (Li) or anything from the Arabic alphabet, these characters will be taken from the fallback.
- If we do need a fallback font, which one should we use? While we can have many fallback fonts, the standard for the absolute last fallback is one of five generic ones, that can be used with any browser or computer system.
- How would we feel about textlint correcting our markdown files such as our README? For a primer on textlint: it bills itself as:
The pluggable linting tool for text and markdown. textlint is similar to ESLint, but it's for use with natural language.
- In essence, textlint suggests corrections for our texts, similiar to MSWord. textlint, however, is somewhat smarter about web-lingo, such as correcting Front End as Frontend, Github as GitHub, and website as site. Are these corrections useful for us?
Questions for dev:
- To Prettier or not to Prettier
Overview
As a developer, we need to periodically review our code to make sure that it is up-to-code, up-to-date, and follow best practices. For this issue, we will discuss linters we can use and install them.
Action Items
Resources/Instructions
Lint (software) Eslint Prettier About continuous integration GitHub Actions github/super-linter
Before working on this issue, be aware that GitHub incorporates its own way of doing CD/CI, via GitHub Actions (GHA). Typically what happens is that a pull request would be created, a GHA is then triggered to generate a linting report to inform the author of the pull request. This report list out linting flags to alert the author and assist them in updating areas of their code. As a matter of fact there are several pre-made GHAs that performs linting. However, linting can encompass many things; it is, after all, a form of code testing. Therefore, for this issue, do broad research on linters so that the team can decide which one best fits our needs.