feat(docs): Update CODE_OF_CONDUCT.md

Update the CODE_OF_CONDUCT.md file to improve clarity and readability. Made changes to the examples of behavior section to ensure it promotes a positive environment for our community.

Signed-off-by: Rodney Osodo <[email protected]>

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
  overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
  professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
@@ -116,13 +116,13 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

Makefile

@@ -1,14 +1,21 @@
+.PHONY: lint
+lint:
+ golangci-lint cache clean && golangci-lint run
+
+.PHONY: examples
+examples:
+ go run examples/female/main.go >> /dev/null && \
+ go run examples/male/main.go >> /dev/null && \
+ go run examples/multiple/main.go >> /dev/null && \
+ go run examples/nonbinary/main.go >> /dev/null
+
 .PHONY: test
 test:
- go test -mod=vendor -v --race -covermode=atomic -coverprofile cover.txt ./...
+ go test --race -covermode=atomic -coverprofile cover.out ./...
 
 .PHONY: cover-html
 cover-html: test
- go tool cover -html cover.txt -o cover.html
-
-.PHONY: lint
-lint:
- golangci-lint cache clean && golangci-lint run --enable-all --disable misspell --disable funlen --disable gofumpt --disable ireturn --disable cyclop --disable lll --disable gosec --disable gochecknoglobals --disable paralleltest --disable wsl --disable gocognit --disable depguard
+ go tool cover -html cover.out -o cover.html
 
 godoc-serve:
  godoc -http=:6060
@@ -24,3 +31,8 @@ precommit:
 .PHONY: update-precommit
 update-precommit:
  pre-commit autoupdate
+
+release:
+ standard-version
+ goreleaser release --clean --release-notes CHANGELOG.md
+ git push --follow-tags origin main

doc.go

@@ -1,20 +1,22 @@
-/*
-Package namegenerator provides a simple way to generate random names.
+// Copyright (c) 0x6flab. All rights reserved.
+//
+// SPDX-License-Identifier: GNU GENERAL PUBLIC LICENSE
 
-Example to generate general names:
-
- package main
-
- import (
- "fmt"
-
- "github.com/0x6flab/namegenerator"
- )
-
- func main() {
- generator := namegenerator.NewNameGenerator("")
- name := generator.Generate()
- fmt.Println(name)
- }
-*/
+// Package namegenerator provides a simple way to generate random names.
+//
+// Example to generate general names:
+//
+// package main
+//
+// import (
+// "fmt"
+//
+// "github.com/0x6flab/namegenerator"
+// )
+//
+// func main() {
+// generator := namegenerator.NewNameGenerator()
+// name := generator.Generate()
+// fmt.Println(name)
+// }
 package namegenerator