Skip to content

Commit 6167e09

Browse files
[REMOVED API OPTIONS FOR NOW]
1 parent 58b3834 commit 6167e09

File tree

4 files changed

+196
-3
lines changed

4 files changed

+196
-3
lines changed

CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to This Project
2+
3+
Thank you for your interest in contributing! We value every contribution and want to maintain a healthy, respectful, and productive community.
4+
5+
## Code of Conduct
6+
This project is committed to providing a welcoming and respectful environment for all contributors.
7+
Please read our [Code of Conduct](CODE_OF_CONDUCT.md), which outlines the expected behavior and the process for reporting unacceptable behavior.
8+
Any violation of the Code of Conduct will be taken seriously and may result in removal from the community.
9+
Thank you for helping to make this project better and for fostering a positive community!
10+
11+
12+
---
13+
14+
## Reporting Issues
15+
16+
If you find bugs, have feature requests, or want to suggest improvements:
17+
18+
- Search existing issues to avoid duplicates.
19+
- Provide a descriptive title and detailed information including:
20+
- Steps to reproduce the issue (if applicable)
21+
- Expected vs. actual behavior
22+
- Environment details (OS, Go version, etc.)
23+
- Relevant logs or error messages
24+
- Be respectful and clear in your communication.
25+
26+
Issues that are vague, incomplete, or disrespectful may be closed without action.
27+
28+
---
29+
30+
## Submitting Pull Requests
31+
32+
We welcome pull requests that improve the project. To ensure smooth reviews and high quality:
33+
34+
1. **Fork** the repository and create a new branch from `main` (or `master`):
35+
36+
```bash
37+
git checkout -b feature/your-feature-name
38+
```
39+
40+
2. Make your changes in the new branch. Ensure that:
41+
- Your code follows the existing style and conventions.
42+
- Your commits are atomic, focused, and include clear, meaningful commit messages.
43+
- You write or update tests to cover new features or bug fixes.
44+
- You update documentation as needed.
45+
46+
3. Test your changes thoroughly before submitting.
47+
48+
4. Push your branch to your fork:
49+
50+
```bash
51+
git push origin feature/your-feature-name
52+
```
53+
5. Open a Pull Request against the main branch of this repository.
54+
55+
6. Fill out the PR description clearly explaining what your changes do and why they are needed.
56+
57+
7. Respond promptly and respectfully to review comments and requested changes.
58+
59+
## PRs may be rejected or closed without merging if:
60+
- They do not follow the contribution guidelines.
61+
- They introduce breaking changes without prior discussion.
62+
- They include insecure, plagiarized, or low-quality code.
63+
- They violate the project’s Code of Conduct.
64+
- They lack necessary tests or documentation.

LICENSE

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Muhammad Ali Khan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+
23+
---
24+
25+
**Additional Disclaimers:**
26+
27+
1. The author is not responsible for any use of this software in violation of applicable laws or regulations. Any illegal or unauthorized use of this software is solely the responsibility of the user.
28+
29+
2. In no event shall the author or copyright holder be liable for any direct, indirect, incidental, special, exemplary, or consequential damages arising out of the use or inability to use the software, even if advised of the possibility of such damages.
30+
31+
3. It is the responsibility of the user to comply with all applicable laws and regulations regarding the use of this software.

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
11
# Go Microservice Boilerplate CLI
22

33
[![Go](https://img.shields.io/badge/go-1.20-blue.svg)](https://golang.org)
4-
[![GitHub Release](https://img.shields.io/github/v/release/your-username/go-microservice-boilerplate)](https://github.com/your-username/go-microservice-boilerplate/releases)
5-
[![License](https://img.shields.io/github/license/your-username/go-microservice-boilerplate)](LICENSE)
4+
[![GitHub Release](https://img.shields.io/github/v/release/your-username/gores)](https://github.com/your-username/go-microservice-boilerplate/releases)
5+
[![License](https://img.shields.io/github/license/your-username/gores)](LICENSE)
66

77
---
88

99
## Introduction
1010

11-
**Go Microservice Boilerplate CLI** is a command-line tool designed to rapidly generate microservice boilerplate code for Go backends. It scaffolds a production-ready project structure including routers, controllers, services, entities, Dockerfiles, and essential configuration files. The generated services follow best practices for modular and maintainable microservice development.
11+
**Go Microservice framework** is a command-line tool designed to rapidly generate microservice boilerplate code for Go backends. It scaffolds a production-ready project structure including routers, controllers, services, entities, Dockerfiles, and essential configuration files. The generated services follow best practices for modular and maintainable microservice development.
1212

1313
This tool supports generating RESTful microservices with plans to extend support for GraphQL and gRPC APIs.
1414

15+
---
16+
17+
## License
18+
19+
This project is licensed under the [MIT License](LICENSE).
20+
You are free to use, modify, and distribute this software — including for commercial purposes — under the terms of the MIT License.
21+
22+
23+
---
24+
25+
## Contributing
26+
27+
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to report issues, request features, and submit pull requests.
28+
29+
1530
---
1631

1732
## Features

0 commit comments

Comments
 (0)