From 2cbefacbb67c424ea1bc32beb55a59778b6e7224 Mon Sep 17 00:00:00 2001 From: Timon Back Date: Sat, 1 Oct 2022 13:32:43 +0200 Subject: [PATCH] docs: Guide for contribution --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9f47d50..7a8a0e0 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,18 @@ dependencies { After starting the application, visit: `localhost:8080/springwolf/asyncapi-ui.html`. +## Contribution + +You are welcome to raise issues and contribute code. + +### Code contribution + +Just fork the project, write code and open a PR. + +This repository uses github actions. We recommend activating them in your fork and open a PR within your fork to trigger them. + +Also, to build a preview for your branch, you can sign up to [Netlify's](https://app.netlify.com) free tier with your github account, import a new site from your github fork and set the build command as described in `src/_redirects`. Open a PR in within your fork and update the code to trigger a build. + ## Development 1. Run `npm i` 2. Run `ng serve`