GO-KIT

Go Kit is a repository of utilitary packages written in Go.

🔗 Table of Contents

• 🚀 Getting Started
  • ☑️ Prerequisites
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with go-kit, ensure your runtime environment meets the following requirements:

• Programming Language: Go
• Package Manager: Npm, Go modules
• Container Runtime: Docker

🤖 Usage

Use any go-kit package in your project following the command:

❯ go get github.com/lcnascimento/go-kit/<desired packaged>

🧪 Testing

Run the test suite using the following command:

❯ make test.unit

---

📌 Project Roadmap

• env
• errors
• o11y
• validator
• httpclient
• grpcserver
• messaging
• featureflag

---

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the go-kit project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/lcnascimento/go-kit

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'feat(package): Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin feat/new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

---