Skip to content

Commit 454df23

Browse files
shyimshyim
authored
Merge pull request #4 from FriendsOfShopware/shokunin/21d460d54cf6
Add contributor documentation and GitHub issue templates
2 parents a2d2bb3 + c7e1b8e commit 454df23

7 files changed

Lines changed: 213 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug report
2+
description: Report a reproducible problem in Shopmon CLI.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting a problem. Please include enough detail for maintainers to reproduce it.
11+
- type: textarea
12+
id: current-behavior
13+
attributes:
14+
label: Current behavior
15+
description: What happened?
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected-behavior
20+
attributes:
21+
label: Expected behavior
22+
description: What did you expect to happen?
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: reproduce
27+
attributes:
28+
label: Steps to reproduce
29+
description: Include commands, environment variables, and any relevant output.
30+
placeholder: |
31+
1. Run ...
32+
2. Set ...
33+
3. See ...
34+
validations:
35+
required: true
36+
- type: input
37+
id: version
38+
attributes:
39+
label: Shopmon CLI version
40+
placeholder: "0.0.6"
41+
validations:
42+
required: false
43+
- type: input
44+
id: go-version
45+
attributes:
46+
label: Go version
47+
placeholder: "go version"
48+
validations:
49+
required: false
50+
- type: input
51+
id: os
52+
attributes:
53+
label: Operating system
54+
placeholder: "Linux, macOS, Docker image, CI environment"
55+
validations:
56+
required: false
57+
- type: textarea
58+
id: additional-context
59+
attributes:
60+
label: Additional context
61+
description: Add logs, links, or screenshots if they help explain the issue.
62+
validations:
63+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature request
2+
description: Suggest an improvement for Shopmon CLI.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem
11+
description: What problem would this solve?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: proposal
16+
attributes:
17+
label: Proposed solution
18+
description: Describe the behavior or API you would like to add or change.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives considered
25+
description: Describe any workarounds or other approaches you considered.
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: additional-context
30+
attributes:
31+
label: Additional context
32+
description: Add examples, related issues, or implementation notes if useful.
33+
validations:
34+
required: false

‎.github/pull_request_template.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
Describe the change and why it is needed.
4+
5+
## Testing
6+
7+
- [ ] `go test ./...`
8+
- [ ] Manual testing completed, if relevant
9+
10+
## Checklist
11+
12+
- [ ] The change is focused and documented clearly.
13+
- [ ] Behavior changes include tests or an explanation for why tests were not added.
14+
- [ ] User-facing documentation is updated, if relevant.

‎CODE_OF_CONDUCT.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Code of Conduct
2+
3+
We want this project to be a welcoming and productive place for contributors.
4+
5+
## Expected Behavior
6+
7+
- Be respectful and constructive.
8+
- Assume good intent while asking for clarification when something is unclear.
9+
- Keep discussion focused on the project and the technical problem being solved.
10+
- Accept maintainer decisions after concerns have been heard and considered.
11+
12+
## Unacceptable Behavior
13+
14+
- Harassment, insults, threats, or personal attacks.
15+
- Discriminatory language or behavior.
16+
- Publishing private information without permission.
17+
- Repeated disruption of issues, pull requests, or maintainer decisions.
18+
19+
## Enforcement
20+
21+
Maintainers may edit, hide, or remove comments, close discussions, block users, or take other action needed to keep the project healthy.
22+
23+
If you need to report a conduct concern, contact the project maintainers through the repository's GitHub organization. Reports will be handled with as much confidentiality as the situation allows.

‎CONTRIBUTING.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing
2+
3+
Thank you for contributing to Shopmon CLI. This project is a small Go command-line tool that is distributed as a native binary, Docker image, and Composer package wrapper.
4+
5+
## Getting Started
6+
7+
1. Fork the repository and create a branch from `main`.
8+
2. Install Go `1.26` or newer.
9+
3. Download dependencies:
10+
11+
```bash
12+
go mod download
13+
```
14+
15+
4. Run the test suite:
16+
17+
```bash
18+
go test ./...
19+
```
20+
21+
## Development
22+
23+
- Keep changes focused on one problem or feature.
24+
- Prefer small pull requests with a clear description of the behavior change.
25+
- Add or update tests when changing behavior.
26+
- Run `gofmt` on changed Go files before opening a pull request.
27+
- Keep user-facing documentation in `README.md` in sync with CLI behavior and environment variables.
28+
29+
## Local Usage
30+
31+
Build the CLI locally:
32+
33+
```bash
34+
go build -o shopmon-cli .
35+
```
36+
37+
Run a deployment command through the CLI:
38+
39+
```bash
40+
SHOPMON_API_KEY="your-token" ./shopmon-cli deploy -- vendor/bin/shopware-deployment-helper run
41+
```
42+
43+
Use `SHOPMON_BASE_URL` when testing against a local or staging Shopmon service.
44+
45+
## Pull Requests
46+
47+
Before requesting review, make sure:
48+
49+
- `go test ./...` passes.
50+
- Any relevant documentation is updated.
51+
- The pull request explains the motivation, implementation, and testing performed.
52+
53+
Maintainers may squash or reword commits when merging.
54+
55+
## Releases
56+
57+
Releases are created by maintainers by pushing tags. GoReleaser builds the native archives and Docker image from the tagged commit.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 FriendsOfShopware
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.

0 commit comments

Comments
 (0)