diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..f05800e7 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +@qdm12 \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..d16bd038 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +Contributions are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [open source license of this project](../LICENSE). + +## Submitting a pull request + +1. [Fork](https://github.com/qdm12/private-internet-access-docker/fork) and clone the repository +1. Create a new branch `git checkout -b my-branch-name` +1. Modify the code +1. Ensure the docker build succeeds `docker build .` +1. Commit your modifications +1. Push to your fork and [submit a pull request](https://github.com/qdm12/private-internet-access-docker/compare) + +## Resources + +- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) diff --git a/README.md b/README.md index 2a4a9a60..bf88f55c 100644 --- a/README.md +++ b/README.md @@ -395,16 +395,48 @@ You can try: ## Development -### Using VSCode and Docker +1. Setup your environment -1. Install [Docker](https://docs.docker.com/install) - - On Windows, share a drive with Docker Desktop and have the project on that partition -1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) -1. In Visual Studio Code, press on `F1` and select `Remote-Containers: Open Folder in Container...` -1. Your dev environment is ready to go!... and it's running in a container :+1: +
Using VSCode and Docker

-The Go code is in the Go file [cmd/main.go](https://github.com/qdm12/private-internet-access-docker/blob/master/cmd/main.go) and the [internal directory](https://github.com/qdm12/private-internet-access-docker/tree/master/internal), -you might want to start reading the main.go file. + 1. Install [Docker](https://docs.docker.com/install/) + - On Windows, share a drive with Docker Desktop and have the project on that partition + - On OSX, share your project directory with Docker Desktop + 1. With [Visual Studio Code](https://code.visualstudio.com/download), install the [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + 1. In Visual Studio Code, press on `F1` and select `Remote-Containers: Open Folder in Container...` + 1. Your dev environment is ready to go!... and it's running in a container :+1: + +

+ +
Locally

+ + Install [Go](https://golang.org/dl/), [Docker](https://www.docker.com/products/docker-desktop) and [Git](https://git-scm.com/downloads); then: + + ```sh + go mod download + go get github.com/golang/mock/gomock + go get github.com/golang/mock/mockgen + ``` + + And finally install [golangci-lint](https://github.com/golangci/golangci-lint#install) + +

+ +1. Commands available: + + ```sh + # Build the entrypoint binary + go build cmd/main.go + # Test the entrypoint code + go test ./... + # Lint the code + golangci-lint run + # Build the Docker image + docker build -t qmcgaw/private-internet-access . + ``` + +1. The Go code is in the Go file [cmd/main.go](https://github.com/qdm12/private-internet-access-docker/blob/master/cmd/main.go) and the [internal directory](https://github.com/qdm12/private-internet-access-docker/tree/master/internal), you might want to start reading the main.go file. +1. See [Contributing](.github/CONTRIBUTING.md) for more information on how to contribute to this repository. ### Contributors