You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@petri.apache.org by wa...@apache.org on 2021/03/16 16:31:59 UTC
[petri-site] branch master updated: Add the linters to the README
This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/petri-site.git
The following commit(s) were added to refs/heads/master by this push:
new 87bc20d Add the linters to the README
new 71fb3c8 Merge pull request #16 from jbampton/update-readme
87bc20d is described below
commit 87bc20d60aa6af1e7c2cc5e14441fd69bdf1ad81
Author: John Bampton <jb...@gmail.com>
AuthorDate: Tue Mar 16 23:03:22 2021 +1000
Add the linters to the README
---
README.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/README.md b/README.md
index 3a1535d..812eb8c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# Apache Petri
+
[Apache Petri](https://petri.apache.org/)
This repository provides the website and source code for Apache Petri.
@@ -18,10 +19,18 @@ CI/CD is via a [.asf.yaml file](https://cwiki.apache.org/confluence/display/INFR
- [ASF YAML build](.asf.yaml) -- ASF infrastructure instructions
JavaScript frameworks available are:
+
- [JQuery 3.3.1 Slim](https://code.jquery.com/jquery-3.3.1.slim.js)
- [Popper 1.14.7](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.js)
- [Bootstrap 4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.js)
CSS frameworks available are:
+
- [Bootstrap 4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.css)
- [GitHub Markdown 3.0.1](https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/3.0.1/github-markdown.css)
+
+Additional testing with GitHub Actions:
+
+- [markdownlint](https://github.com/DavidAnson/markdownlint) -- using [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) - Node.js style checker and lint tool for Markdown/CommonMark files
+- [misspell](https://github.com/client9/misspell) -- Golang library to correct commonly misspelled English words quickly
+- [yamllint](https://yamllint.readthedocs.io/en/stable/) -- a linter for YAML files