-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Adding CoC, ReadMe and Makefile
Signed-off-by: Pritesh Bandi <[email protected]>
- Loading branch information
1 parent
afc5fb9
commit 3acb38d
Showing
3 changed files
with
68 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code of Conduct | ||
|
||
Notation follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Copyright The Notary Project Authors. | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
.PHONY: help | ||
help: | ||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-25s\033[0m %s\n", $$1, $$2}' | ||
|
||
.PHONY: all | ||
all: test | ||
|
||
.PHONY: test | ||
test: check-line-endings ## run unit tests | ||
go test -race -v -coverprofile=coverage.txt -covermode=atomic ./... | ||
|
||
.PHONY: clean | ||
clean: | ||
git status --ignored --short | grep '^!! ' | sed 's/!! //' | xargs rm -rf | ||
|
||
.PHONY: check-line-endings | ||
check-line-endings: ## check line endings | ||
! find . -name "*.go" -type f -exec file "{}" ";" | grep CRLF | ||
! find scripts -name "*.sh" -type f -exec file "{}" ";" | grep CRLF | ||
|
||
.PHONY: fix-line-endings | ||
fix-line-endings: ## fix line endings | ||
find . -type f -name "*.go" -exec sed -i -e "s/\r//g" {} + |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,30 @@ | ||
# notation-plugin-framework-go | ||
Contains framework or base for notation plugins | ||
|
||
[![Build Status](https://github.com/notaryproject/notation-plugin-framework-go/actions/workflows/build.yml/badge.svg?event=push&branch=main)](https://github.com/notaryproject/notation-plugin-framework-go/actions/workflows/build.yml?query=workflow%3Abuild+event%3Apush+branch%3Amain) | ||
[![Codecov](https://codecov.io/gh/notaryproject/notation-plugin-framework-go/branch/main/graph/badge.svg)](https://codecov.io/gh/notaryproject/notation-plugin-framework-go) | ||
[![Go Reference](https://pkg.go.dev/badge/github.com/notaryproject/notation-plugin-framework-go.svg)](https://pkg.go.dev/github.com/notaryproject/notation-plugin-framework-go@main) | ||
|
||
notation-plugin-framework-go contains framework or library required to create notation plugins as per [Notary Project specifications](https://github.com/notaryproject/specifications). | ||
|
||
Please visit [README](https://github.com/notaryproject/.github/blob/main/README.md) to know more about Notary Project. | ||
|
||
> [!NOTE] | ||
> The Notary Project documentation is available [here](https://notaryproject.dev/docs/). | ||
## Table of Contents | ||
|
||
- [Documentation](#documentation) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [License](#license) | ||
|
||
## Documentation | ||
|
||
Library documentation is available at [Go Reference](https://pkg.go.dev/github.com/notaryproject/notation-plugin-framework-go). | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for further details. | ||
|
||
## License | ||
|
||
This project is covered under the Apache 2.0 license. You can read the license [here](LICENSE). |