covid19/cwa-documentation
covid19/cwa-documentation
1
0
Fork 0
mirror of https://github.com/corona-warn-app/cwa-documentation synced 2025-07-04 12:28:35 +02:00
Code Releases Activity

feat: Use makefile targets for document linting (#215)

Browse source 
This Makefile provides several targets for linting
documents. It utilizes several npm packages.
Functionality includes:

* Spellcheck
* Linting of markdown
* Check for broken links
* Sorting of dictionary file
* Detect inconsidered language

All targets (excluding the sorting of the dict file) are part
of the Github Action pipeline and will fail if quality
standards are not met.

Signed-off-by: Johannes Amorosa <johannes.amorosa@endocode.com>
This commit is contained in:
Johannes Amorosa 2020-07-05 15:37:23 +02:00 • committed by GitHub
parent f44275d4b1
commit 02caed10d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 4073 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -1,10 +1,14 @@
# Contributing
## Build status
![Checks](https://github.com/corona-warn-app/cwa-documentation/workflows/Checks/badge.svg)
## Code of Conduct
All members of the project community must abide by the [Contributor Covenant, version 2.0](CODE_OF_CONDUCT.md).
Only by respecting each other we can develop a productive, collaborative community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [corona-warn-app.opensource@sap.com](mailto:corona-warn-app.opensource@sap.com) and/or a project maintainer.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [corona-warn-app.opensource@sap.com](mailto:corona-warn-app.opensource@sap.com) and/or a project maintainer.
We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers.
@ -38,7 +42,8 @@ The following rule governs code contributions:
## Contributing Documentation
You are welcome to contribute documentation to the project.
You are welcome to contribute documentation to the project. Please see the
installation [document](INSTALL.md)
The following rule governs documentation contributions:
@ -64,7 +69,7 @@ The following rule governs documentation contributions:
## Issues and Planning
* We use GitHub issues to track bugs and enhancement requests.
* We use GitHub issues to track bugs and enhancement requests.
* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. Therefore, contributors should use but aren't restricted to the issue template provided by the project maintainers.