Skip to content

Commit f7facb2

Browse files
fidpafidpa
committed
v1.2.0
1 parent 66e3325 commit f7facb2

File tree

12 files changed

+1026
-7
lines changed

12 files changed

+1026
-7
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## 🐛 Bug Description
10+
11+
<!-- Clear and concise description of the bug -->
12+
13+
## 📋 Steps to Reproduce
14+
15+
1. Run command: `ssc ...`
16+
2. With configuration: `...`
17+
3. Observe error: `...`
18+
19+
## ✅ Expected Behavior
20+
21+
<!-- What should happen? -->
22+
23+
## ❌ Actual Behavior
24+
25+
<!-- What actually happened? -->
26+
27+
## 📊 Environment
28+
29+
- **OS**: <!-- e.g., Ubuntu 22.04, macOS 13 -->
30+
- **Bash Version**: <!-- Run: bash --version -->
31+
- **yq Version**: <!-- Run: yq --version -->
32+
- **ssc Version**: <!-- Run: ssc --version or check ssc.sh line 27 -->
33+
- **Installation Method**: <!-- local alias / system-wide / user-local -->
34+
35+
## 📝 Relevant Configuration
36+
37+
<!-- If applicable, include relevant parts of manifest.yaml -->
38+
39+
```yaml
40+
# Paste relevant manifest entries here
41+
```
42+
43+
## 📄 Logs/Output
44+
45+
<!-- Include relevant command output or error messages -->
46+
47+
```bash
48+
# Paste output here
49+
```
50+
51+
## 🔍 Additional Context
52+
53+
<!-- Any other context about the problem -->
54+
55+
## ✅ Checklist
56+
57+
- [ ] I have checked [TROUBLESHOOTING.md](../../docs/TROUBLESHOOTING.md)
58+
- [ ] I have searched existing issues
59+
- [ ] I can reproduce this bug consistently
60+
- [ ] I have included all required information above

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 💡 Feature Description
10+
11+
<!-- Clear and concise description of the feature -->
12+
13+
## 🎯 Use Case
14+
15+
<!-- What problem does this solve? Who would benefit? -->
16+
17+
## 📝 Proposed Solution
18+
19+
<!-- How should this feature work? -->
20+
21+
## 🔄 Alternative Solutions
22+
23+
<!-- Have you considered any alternative approaches? -->
24+
25+
## 📊 Examples
26+
27+
<!-- Provide examples of how this would be used -->
28+
29+
```bash
30+
# Example command usage
31+
ssc new-feature --option value
32+
```
33+
34+
## ✅ Acceptance Criteria
35+
36+
<!-- What defines this feature as "complete"? -->
37+
38+
- [ ] Criterion 1
39+
- [ ] Criterion 2
40+
- [ ] Documentation updated
41+
- [ ] Tests added
42+
43+
## 🔗 Related Issues
44+
45+
<!-- Link to related issues or PRs -->
46+
47+
## 📚 Additional Context
48+
49+
<!-- Any other context, screenshots, or references -->
50+
51+
## 💭 Impact Assessment
52+
53+
- **Complexity**: <!-- Low / Medium / High -->
54+
- **Breaking Change**: <!-- Yes / No -->
55+
- **Documentation Required**: <!-- Yes / No -->
56+
- **Priority**: <!-- Low / Medium / High -->
57+
58+
## ✅ Checklist
59+
60+
- [ ] I have searched existing issues and PRs
61+
- [ ] This feature aligns with the project's goals
62+
- [ ] I am willing to contribute to implementation (optional)

‎.github/pull_request_template.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
## 📝 Pull Request Description
2+
3+
<!-- Clear and concise description of your changes -->
4+
5+
## 🎯 Related Issue
6+
7+
<!-- Link to related issue(s) -->
8+
9+
Fixes #
10+
Related to #
11+
12+
## 🔄 Type of Change
13+
14+
<!-- Mark the relevant option with an [x] -->
15+
16+
- [ ] 🐛 Bug fix (non-breaking change fixing an issue)
17+
- [ ] ✨ New feature (non-breaking change adding functionality)
18+
- [ ] 💥 Breaking change (fix or feature causing existing functionality to change)
19+
- [ ] 📚 Documentation update
20+
- [ ] 🔧 Refactoring (no functional changes)
21+
- [ ] ✅ Tests (adding or updating tests)
22+
23+
## ✅ Testing
24+
25+
<!-- Describe how you tested your changes -->
26+
27+
- [ ] I have tested this locally
28+
- [ ] All tests pass (`./ssc.sh validate`)
29+
- [ ] I have added new tests (if applicable)
30+
31+
**Test Commands Used**:
32+
```bash
33+
# List commands used to test
34+
ssc list
35+
ssc run example-script
36+
```
37+
38+
## 📋 Checklist
39+
40+
- [ ] My code follows the project's style guidelines
41+
- [ ] I have performed a self-review of my code
42+
- [ ] I have commented complex code sections
43+
- [ ] I have updated documentation (if needed)
44+
- [ ] My changes generate no new warnings
45+
- [ ] I have added entries to CHANGELOG.md
46+
- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md)
47+
48+
## 📸 Screenshots (if applicable)
49+
50+
<!-- Add screenshots for UI changes -->
51+
52+
## 📚 Documentation Changes
53+
54+
<!-- List documentation files modified -->
55+
56+
- [ ] README.md
57+
- [ ] docs/SETUP.md
58+
- [ ] docs/MANIFEST_SCHEMA.md
59+
- [ ] docs/TROUBLESHOOTING.md
60+
- [ ] CHANGELOG.md
61+
62+
## 🔍 Additional Context
63+
64+
<!-- Any additional information about the PR -->
65+
66+
## 🎓 Learning Notes
67+
68+
<!-- Optional: What did you learn while working on this? -->
69+
70+
---
71+
72+
**By submitting this PR, I confirm**:
73+
- [ ] My contributions are my own and I agree to license them under MIT
74+
- [ ] I have followed the [Code of Conduct](../CODE_OF_CONDUCT.md)

‎CHANGELOG.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ All notable changes to server-scripts-cli will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.2.0] - 2026-01-20
9+
10+
### Added
11+
- **Automated Installer** (`install.sh`): One-liner installation with 3 modes
12+
- `--local`: Add alias to ~/.bashrc (default)
13+
- `--user`: Symlink to ~/.local/bin
14+
- `--system`: Install to /usr/local/bin (requires sudo)
15+
- Prerequisites check (Bash 4.0+, yq, git)
16+
- Color-coded logging and idempotent execution
17+
- **Contributing Guide** (`CONTRIBUTING.md`): Fork → Branch → PR workflow
18+
- **Security Policy** (`SECURITY.md`): Vulnerability disclosure process
19+
- **Code of Conduct** (`CODE_OF_CONDUCT.md`): Contributor Covenant v2.1
20+
- **GitHub Issue Templates**: Bug Report and Feature Request templates
21+
- **GitHub PR Template**: Standardized pull request format
22+
- **Subdir Navigation**: `docs/README.md` and `examples/README.md` index files
23+
24+
### Changed
25+
- **README.md**: Complete overhaul
26+
- Added 7 professional badges (Version, License, Bash, Platform, Maintenance, YAML, Contributions)
27+
- One-liner installation as primary method
28+
- Manual installation moved to collapsible `<details>` section
29+
- New "Contributing" section with links to community docs
30+
- Updated Documentation and Examples sections with index links
31+
32+
### Documentation
33+
- Added `docs/README.md` - Documentation index with file descriptions
34+
- Added `examples/README.md` - Demo scripts overview with usage guide
35+
836
## [1.1.1] - 2026-01-17
937

1038
### Fixed

‎CODE_OF_CONDUCT.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment:
18+
19+
* Demonstrating empathy and kindness toward other people
20+
* Being respectful of differing opinions, viewpoints, and experiences
21+
* Giving and gracefully accepting constructive feedback
22+
* Accepting responsibility and apologizing to those affected by our mistakes
23+
* Focusing on what is best not just for us as individuals, but for the community
24+
25+
Examples of unacceptable behavior:
26+
27+
* The use of sexualized language or imagery, and sexual attention of any kind
28+
* Trolling, insulting or derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards
36+
of acceptable behavior and will take appropriate and fair corrective action
37+
in response to any behavior that they deem inappropriate, threatening,
38+
offensive, or harmful.
39+
40+
## Scope
41+
42+
This Code of Conduct applies within all community spaces, and also applies
43+
when an individual is officially representing the community in public spaces.
44+
45+
## Enforcement
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
48+
reported to the project maintainers via GitHub Issues. All complaints will be
49+
reviewed and investigated promptly and fairly.
50+
51+
## Attribution
52+
53+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
54+
version 2.1, available at
55+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
56+
57+
[homepage]: https://www.contributor-covenant.org
58+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

‎CONTRIBUTING.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Contributing to Server Scripts CLI
2+
3+
Thank you for considering contributing to `server-scripts-cli`! This document outlines the process for contributing to this project.
4+
5+
## 🚀 Quick Start
6+
7+
```bash
8+
# 1. Fork the repository on GitHub
9+
# 2. Clone your fork
10+
git clone https://github.com/YOUR_USERNAME/server-scripts-cli
11+
cd server-scripts-cli
12+
13+
# 3. Create a feature branch
14+
git checkout -b feature/your-feature-name
15+
16+
# 4. Make your changes
17+
# 5. Test your changes
18+
./ssc.sh list
19+
./ssc.sh validate
20+
21+
# 6. Commit with semantic versioning in mind
22+
git add .
23+
git commit -m "Add: Feature description"
24+
25+
# 7. Push to your fork
26+
git push origin feature/your-feature-name
27+
28+
# 8. Open a Pull Request on GitHub
29+
```
30+
31+
## 📋 Contribution Guidelines
32+
33+
### Code Style
34+
35+
- **Bash Scripts**: Follow existing patterns (`set -uo pipefail`, error handling, readonly variables)
36+
- **Indentation**: 4 spaces (no tabs)
37+
- **Functions**: Use `snake_case` naming
38+
- **Variables**: Use `SCREAMING_SNAKE_CASE` for constants, `snake_case` for locals
39+
- **Comments**: Document complex logic, use `# =====` section separators
40+
41+
### Testing
42+
43+
Before submitting a PR, ensure:
44+
- [ ] `./ssc.sh list` works correctly
45+
- [ ] `./ssc.sh validate` passes
46+
- [ ] Script follows shellcheck recommendations
47+
- [ ] Documentation is updated (if adding features)
48+
49+
### Documentation
50+
51+
- Update `README.md` if adding user-facing features
52+
- Update `docs/MANIFEST_SCHEMA.md` if changing YAML schema
53+
- Add entries to `CHANGELOG.md` (Keep a Changelog format)
54+
55+
### Commit Messages
56+
57+
Use clear, descriptive commit messages:
58+
59+
```
60+
Add: New feature description
61+
Fix: Bug fix description
62+
Docs: Documentation update
63+
Refactor: Code improvement without behavior change
64+
Test: Add or update tests
65+
```
66+
67+
## 🐛 Reporting Bugs
68+
69+
Use the [Bug Report template](.github/ISSUE_TEMPLATE/bug_report.md) and include:
70+
- Steps to reproduce
71+
- Expected vs. actual behavior
72+
- Environment (Bash version, OS, yq version)
73+
- Relevant logs or error messages
74+
75+
## 💡 Feature Requests
76+
77+
Use the [Feature Request template](.github/ISSUE_TEMPLATE/feature_request.md) and describe:
78+
- Use case and motivation
79+
- Proposed solution
80+
- Alternative solutions considered
81+
82+
## 📜 Code of Conduct
83+
84+
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
85+
86+
## 🔄 Pull Request Process
87+
88+
1. **Fork & Branch**: Create a feature branch from `main`
89+
2. **Develop**: Make your changes with clear commits
90+
3. **Test**: Ensure all tests pass and functionality works
91+
4. **Document**: Update relevant documentation
92+
5. **Submit**: Open a PR with a clear description
93+
6. **Review**: Address feedback from maintainers
94+
7. **Merge**: Once approved, your PR will be merged
95+
96+
## 📝 License
97+
98+
By contributing, you agree that your contributions will be licensed under the MIT License.
99+
100+
## 🙏 Thank You!
101+
102+
Your contributions help make `server-scripts-cli` better for everyone. We appreciate your time and effort!
103+
104+
---
105+
106+
**Questions?** Open an issue or reach out to [@fidpa](https://github.com/fidpa).

0 commit comments

Comments
 (0)