An open API service indexing awesome lists of open source software.

https://github.com/g-core/gcore-waap-sdk-go


https://github.com/g-core/gcore-waap-sdk-go

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# 🤝 Contribution Guide

This repository is intended for building SDKs for WAAP product. Please follow this guide to contribute effectively.

---

## ✅ Getting Started

Clone Repo

```bash
git clone git@github.com:G-Core/gcore-waap-sdk-go.git
cd gcore-waap-sdk-go
```

Create a New Branch. Use a descriptive branch name like:

```bash
git checkout -b feature/short-description
```

# 🛠 Development Guidelines

- Follow clean code practices and naming conventions.
- Keep commits focused and atomic.
- For SDKs, follow idiomatic patterns for the target language.
- Write tests where applicable.
- Document public interfaces and usage examples.

# 📤 Submitting a Pull Request

1. Push your branch:
```bash
git push origin feature/short-description
```
2. Open a Pull Request to the main branch.
3. Make sure your PR includes:
1. A clear description of the changes
1. Any special considerations
1. How to test the changes (if needed)

# 🔍 Review Process

- We’ll review PRs as quickly as possible.
- Feedback may be requested before approval.
- Once approved, we’ll take care of merging and any post-merge steps.

# 💬 Questions or Issues?

Open an issue or reach out to us directly if anything is unclear.

# ⚖️ License

This project is licensed under the Apache License 2.0. See the [LICENSE](https://github.com/G-Core/gcore-waap-sdk-go/blob/main/LICENSE) file for details.

# 🙏 Thank You!