diff --git a/CONTRIBUING.md b/CONTRIBUING.md new file mode 100644 index 0000000..8b883f7 --- /dev/null +++ b/CONTRIBUING.md @@ -0,0 +1,33 @@ +# Contributing guidelines + +## Sending patches + +You can send patches into this project via: + +* **GitLab**: +* **GitHub**: +* **Mailing list (via `git send-email`)**: `~ajhalili2006/public-inbox@lists.sr.ht` (preferred) or `ajhalili2006@googlegroups.com` + +### Setting up `git-email` + +See for instructions on how to install `git-email` package and setting up email authenication. + +After that: + +```bash +# send to mailing list (using the lists.sr.ht address is recommended) +git config sendemail.to "~ajhalili2006/public-inbox@lists.sr.ht" +# alternative in case of downtime, but not recommended +git config sendemail.to "ajhalili2006@googlegroups.com" + +# add subject prefix for project +git config format.subjectPrefix "PATCH golang-pkgs" + +# sign-off your patches per https://dco.andreijiroh.xyz +git config format.signOff yes + +# use --annotate by default +git config --global sendemail.annotate yes +``` + +Once fully configured, just `git send-email v HEAD^` and wait for a reply from ~ajhalili2006 for feedback. diff --git a/README.md b/README.md index f5cfa6b..799d7ec 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# golang-pkgs +# `packages.andreijiroh.xyz/golang` - ~ajhalili2006's golang packages in a monorepo + Monorepo of Golang packages, mostly experimential and sometimes involves Caddy plugin dev. + +## What's inside? + +| Package name and description | Package URL | GoDoc | +| --- | --- | --- | +| [`caddy-dns-oblong`](./caddy-dns-oblong/) - Caddy DNS plugin for `obl.ong` domains | | [![Go Reference](https://pkg.go.dev/badge/test.svg)](https://pkg.go.dev/packages.andreijiroh.xyz/golang/caddy-dns-oblong) +| [`libdns-oblong`](./libdns-oblong/) - obl.ong for libdns | | [![Go Reference](https://pkg.go.dev/badge/test.svg)](https://pkg.go.dev/packages.andreijiroh.xyz/golang/libdns-oblong) + +## Contributing + +See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for all the ways you can contribute +to this monorepo project. + +## License + +Check the package's `LICENSE` file and comments at the top on per-file basis +for what's applicable. Otherwise, MIT license applies for simplicity. \ No newline at end of file