From c4f8090725b9f19ae3f0a8570100b50744f8a18b Mon Sep 17 00:00:00 2001 From: Guillaume Belanger Date: Sat, 27 Jan 2024 08:46:45 -0500 Subject: [PATCH] chore: Add contributing file (#2) --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..106ce12 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +## Getting Started + +1. Fork the repository on GitHub +2. Clone the forked repository to your local machine +3. Build the project: `go build cmd/sepp/main.go` +4. Run the project: `./main --config=config.yaml` + +## Testing + +### Unit Tests + +```bash +go test ./... +``` + +### Lint + +```bash +golangci-lint run ./... +``` diff --git a/README.md b/README.md index aa78794..6ebe57a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Security Edge Protection Proxy (SEPP) -An open source implementation of the Security Edge Protection Proxy (SEPP). +An open source implementation of the 5G Security Edge Protection Proxy (SEPP). ## Reference