From 474236c77fbde51d24b0f561f89661e23adefb02 Mon Sep 17 00:00:00 2001 From: Timon Borter Date: Mon, 26 Sep 2022 17:57:01 +0200 Subject: [PATCH] docs: enhance developer documentation --- DEVELOPMENT.md | 7 ++++--- README.md | 9 +++++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 92e8d38..bdc7720 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -27,12 +27,13 @@ the available types. ### `semantic-release` -The pipeline uses [`semantic-release`](https://github.com/semantic-release/semantic-release/) internally. Take a look at +The pipeline uses the npm package [`semantic-release`](https://github.com/semantic-release/semantic-release/) +internally. Take a look at the [`release`-workflow](https://github.com/postfinance/polling-swagger-ui/blob/release/.github/workflows/release.yaml) or -[the official documentation](https://github.com/semantic-release/github/) in order to get started. +[the official documentation](https://github.com/semantic-release/github/) if you want to know more about it. -An access token (`GITHUB_TOKEN`) with the following scope is required for `semantic-release` to work properly: `public_repo` +Also, note that it uses the default `GITHUB_TOKEN` for interacting with GitHub. . ## Docker Tagging diff --git a/README.md b/README.md index a721aaf..5efcb74 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,11 @@ Polling Swagger-UI * [Configuration](#configuration) * [Docker Container](#docker-container) + * [Node.js](#nodejs) * [Swagger](#swagger) * [Running the Container](#running-the-container) +* [Contributing](#contributing) +* [License](#license) # Configuration @@ -69,6 +72,12 @@ docker run \ postfinance/polling-swagger-ui:1.0.0 ``` +# Contributing + +Contributors may find help in +the [`DEVELOPMENT.md`](https://github.com/postfinance/polling-swagger-ui/blob/release/DEVELOPMENT.md). It contains +useful resources on how to behave when contributing, so we can accept your pull-requests without big trouble 😉 + # License This project is licensed under the terms of