Merge pull request #28 from ybkuroki/develop

Add contribution

.github/workflows/check.yml

@@ -26,7 +26,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: install lint
-        run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.29.0
+        run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.32.2
       - name: lint
         run: golangci-lint run
       - name: test

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contribution
+## Preface
+Thank you for considering contributing to this sample application.
+I would like to create the sample application such as helpful when you would like to develop a web application using golang.
+
+## How to report a bug
+Please create a issue which wrote about the following points when you report a bug.
+
+1. Version of golang you are using
+1. Operating system you are using
+1. Reprocedure
+1. Expected behavior
+
+Also, please write about it when you know the causes and how to fix the bug.
+
+1. Cause
+1. How to fix
+
+## How to suggest a feature or enhancement
+Please create a issue which wrote that purpose and expected behavior, when you have functions which you would like to implement as a sample.
+
+1. Purpose
+1. Expected behavoir, What kind of function do you propose?
+1. How to develop
+
+## How to create a pull request
+You can feel free to fork this repository, fix the source code and create a pull request when you have noticed that you can resolve a issue.
+And after that, please check passed the check workflow of GitHub Action.
+
+I will check your pull request, and I may suggest some improvements or alternatives.
+If there was no problem, I will merge your changes.

README.md

@@ -6,7 +6,12 @@
 [![release](https://img.shields.io/github/release/ybkuroki/go-webapp-sample?style=for-the-badge&logo=github)](https://github.com/ybkuroki/go-webapp-sample/releases)
 
 ## Preface
-This sample project uses [Echo](https://echo.labstack.com/) and [Gorm](https://gorm.io/) written by [Golang](https://golang.org/). It provides only Web API. So, I recommend using a [vuejs-webapp-sample](https://github.com/ybkuroki/vuejs-webapp-sample) project as Web UI.
+This repository is the sample of web application using golang.
+This sample uses [Echo](https://echo.labstack.com/), [Gorm](https://gorm.io/) and [Zap logger](https://pkg.go.dev/go.uber.org/zap).
+This sample application provides only functions via Web APIs.
+So, if you would like to use web UI, I will recommend using [vuejs-webapp-sample](https://github.com/ybkuroki/vuejs-webapp-sample) with this application. 
+
+If you would like to develop a web application using golang, please feel free to use this sample.
 
 ## Install
 Perform the following steps:
@@ -103,5 +108,8 @@ This sample uses the following libraries.
 |go-playground/validator.v9|9.31.0|
 |Zap/logger|1.16.0|
 
+## Contribution
+Please read CONTRIBUTING.md for proposing new functions, reporting bugs and submitting pull requests before contributing to this repository.
+
 ## License
 The License of this sample is *MIT License*.