Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit a25cab5

Browse files
mstrYodamstrYoda
authored
Merge pull request #18 from umutphp/master
A Batch Of Documentation Updates
2 parents d62813b + 411d7e2 commit a25cab5

File tree

9 files changed

+256
-19
lines changed

9 files changed

+256
-19
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes #_issue-number_
6+
7+
## Type of change
8+
9+
Please select the type of change.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
16+
# How Can This Be Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

‎.github/workflows/lint.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Lint Actions
2+
on: [push]
3+
4+
jobs:
5+
markdownlint:
6+
runs-on: ubuntu-latest
7+
name: Markdown Linter
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v2
11+
- name: markdownlint-cli
12+
uses: nosborn/github-action-markdown-cli@v1.1.1
13+
with:
14+
files: "README.md"

‎.github/workflows/wospm.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Checks For Open Source
2+
on: [push]
3+
4+
jobs:
5+
wospm_checker:
6+
runs-on: ubuntu-latest
7+
name: WOSPM Checker
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v2
11+
- name: WOSPM Checker Github Action
12+
uses: WOSPM/wospm-checker-github-action@v1
13+
- name: Upload HTML Report When Success
14+
uses: actions/upload-artifact@v1
15+
with:
16+
name: HTML Report
17+
path: wospm.html
18+
- name: Upload HTML Report When Failed
19+
uses: actions/upload-artifact@v1
20+
if: failure()
21+
with:
22+
name: HTML Report
23+
path: wospm.html

‎.markdownlint.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"line-length": false,
3+
"no-inline-html": {
4+
"allowed_elements": [
5+
"a", "img"
6+
]
7+
}
8+
}

‎CODE_OF_CONDUCT

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

‎CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/Trendyol/docker-shell/pulls).
6+
7+
## Pull Requests
8+
9+
- **Sync** - Please make sure your forked repository is up to date with ours to avoid conflicts as much as possible.
10+
- **Language** - Please make sure to check your contribution for grammar mistakes and typos as much as possible.
11+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
12+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
13+
14+
15+
**Stay Secure**!

‎README.md

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,73 @@
11
# docker-shell
22

3-
[![License: MIT](https://img.shields.io/badge/License-MIT-ligthgreen.svg)](https://opensource.org/licenses/MIT)
3+
A simple interactive prompt for Docker. Inspired from [kube-prompt](https://github.com/c-bata/kube-prompt) uses [go-prompt](https://github.com/c-bata/go-prompt).
44

5-
A simple interactive prompt for docker. Inspired from [kube-prompt](https://github.com/c-bata/kube-prompt) uses [go-prompt](https://github.com/c-bata/go-prompt).
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-ligthgreen.svg)](https://opensource.org/licenses/MIT) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CONTRIBUTING.md)
66

7-
[![asciicast](https://asciinema.org/a/AKDTBnD3gKKzACDdj7Tm670PJ.svg)](https://asciinema.org/a/AKDTBnD3gKKzACDdj7Tm670PJ)
7+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
8+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
9+
## Table Of Contents
810

9-
<h4>Image suggestion from docker hub</h4>
11+
- [Features:](#features)
12+
- [Installation](#installation)
13+
- [Homebrew](#homebrew)
14+
- [Build From Source Code](#build-from-source-code)
15+
- [How To Use](#how-to-use)
16+
- [How To Contribute](#how-to-contribute)
1017

11-
[![asciicast](https://asciinema.org/a/UCfYZNXCcVxIiqNKsAMtEhmiM.svg)](https://asciinema.org/a/UCfYZNXCcVxIiqNKsAMtEhmiM)
18+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1219

13-
<h4>Port mapping suggestion</h4>
20+
## Features
1421

15-
[![asciicast](https://asciinema.org/a/7aWKWQJqqHZkpWZXwfy8AcrPj.svg)](https://asciinema.org/a/7aWKWQJqqHZkpWZXwfy8AcrPj)
22+
- [X] Suggest docker commands
23+
- [X] List container ids&names after docker exec/start/stop commands
24+
- [ ] Suggest command parameters based on typed command
25+
- [X] List images from docker hub after docker pull command [v1.2.0](https://github.com/Trendyol/docker-shell/milestone/1)
26+
- [X] Suggest port mappings after docker run command [v1.3.0](https://github.com/Trendyol/docker-shell/milestone/2)
27+
- [X] Suggest available images after docker run command [v1.3.0](https://github.com/Trendyol/docker-shell/milestone/2)
28+
29+
## Installation
30+
31+
### Homebrew
32+
33+
You can install by using *homebrew*:
34+
35+
```bash
36+
brew tap trendyol/trendyol-tap
37+
38+
brew install docker-shell
39+
```
40+
41+
### Build From Source Code
42+
43+
You can build the command from source code by following the steps below:
1644

17-
Features:
45+
```bash
46+
git clone git@github.com:Trendyol/docker-shell.git
1847

19-
* [X] Suggest docker commands
20-
* [X] List container ids&names after docker exec/start/stop commands
21-
* [ ] Suggest command parameters based on typed command
22-
* [X] List images from docker hub after docker pull command [v1.2.0](https://github.com/Trendyol/docker-shell/milestone/1)
23-
* [X] Suggest port mappings after docker run command [v1.3.0](https://github.com/Trendyol/docker-shell/milestone/2)
24-
* [X] Suggest available images after docker run command [v1.3.0](https://github.com/Trendyol/docker-shell/milestone/2)
48+
cd docker-shell
2549

50+
sudo go build -o /usr/local/bin/docker-shell .
2651

27-
<h3>Installation</h3>
52+
docker-shell
53+
```
2854

29-
<b>Homebrew</b> :
55+
## How To Use
56+
57+
After installation, you can type `docker-shell` and run the interactive shell.
58+
59+
[![asciicast](https://asciinema.org/a/AKDTBnD3gKKzACDdj7Tm670PJ.svg)](https://asciinema.org/a/AKDTBnD3gKKzACDdj7Tm670PJ)
60+
61+
Image suggestion from docker hub:
62+
63+
[![asciicast](https://asciinema.org/a/UCfYZNXCcVxIiqNKsAMtEhmiM.svg)](https://asciinema.org/a/UCfYZNXCcVxIiqNKsAMtEhmiM)
64+
65+
Port mapping suggestion:
66+
67+
[![asciicast](https://asciinema.org/a/7aWKWQJqqHZkpWZXwfy8AcrPj.svg)](https://asciinema.org/a/7aWKWQJqqHZkpWZXwfy8AcrPj)
3068

31-
`brew tap trendyol/trendyol-tap`
69+
## How To Contribute
3270

33-
`brew install docker-shell`
71+
Contributions are **welcome** and will be fully **credited**.
3472

35-
After install it you can type `docker-shell` and run interactive shell.
73+
Please read the [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT) files for details.

0 commit comments

Comments
 (0)