chore: Add contributing file (#2)

yeastengine · Jan 27, 2024 · c4f8090 · c4f8090
1 parent 2ac28fd
commit c4f8090
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/CONTRIBUTING.md 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
@@ -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