Skip to content

Commit

Permalink
Merge pull request #399 from meshery/fix/tidy
Browse files Browse the repository at this point in the history
Add make tidy
  • Loading branch information
Aisuko authored Oct 22, 2023
2 parents f4d50f1 + 3bfe3c1 commit d53aa2b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,18 @@ All contributors are invited to review pull requests. See this short video on [h
# New to Git?
Resources: https://lab.github.com and https://try.github.com/


# FQA

### Instructions for making custom dictionary entries

Enter new key:value pairs into the `useDictionary()` map in https://github.com/meshery/meshkit/blob/master/utils/utils.go

- Key: string to match
- Value: string to display

The custom dictionary entries are case insensitive.

### License

This repository and site are available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
Expand Down
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ check:
test:
go test --short ./... -race -coverprofile=coverage.txt -covermode=atomic

tidy:
go mod tidy
git diff --exit-code go.mod go.sum

errorutil:
go run github.com/layer5io/meshkit/cmd/errorutil -d . update --skip-dirs meshery -i ./helpers -o ./helpers

Expand Down
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
# MeshKit for Meshery and it's ecosystem
A toolkit for Meshery's microservices and various individual architectural components to reuse and share common functionality. Learn more: [Introducing MeshKit and the Meshery Adapter Library](https://layer5.io/blog/meshery/introducing-meshkit-and-the-meshery-adapter-library)

![](https://github.com/meshery/meshkit/actions/workflows/ci.yml/badge.svg)
![](https://github.com/meshery/meshkit/actions/workflows/release-drafter.yml/badge.svg)
![](https://github.com/meshery/meshkit/actions/workflows/error-codes-updater.yaml/badge.svg)


### Instructions for making custom dictionary entries

Enter new key:value pairs into the `useDictionary()` map in https://github.com/meshery/meshkit/blob/master/utils/utils.go

- Key: string to match
- Value: string to display

The custom dictionary entries are case insensitive.

[![](https://github.com/meshery/meshkit/actions/workflows/ci.yml/badge.svg)](https://github.com/meshery/meshkit/actions/workflows/ci.yml)
[![](https://github.com/meshery/meshkit/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/meshery/meshkit/actions/workflows/release-drafter.yml)
[![](https://github.com/meshery/meshkit/actions/workflows/error-codes-updater.yaml/badge.svg)](https://github.com/meshery/meshkit/actions/workflows/error-codes-updater.yaml)

<div>&nbsp;</div>

Expand Down

0 comments on commit d53aa2b

Please sign in to comment.