Skip to content

Commit

Permalink
added contributng doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcelo Ochoa committed Nov 8, 2022
1 parent 5edd0d7 commit 2019769
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to JSONCrack Docker Extension

Hi, glad to know that you're interested in contributing. Here are
some topics that can help you to get started:

- 💡 [Bugs and features](#bugs-and-features)
- 🔧 [Environment setup](#environment-setup)

## Bugs and features

Whether it's a bug report or feature request, you're welcome to raise an
**[issue](https://github.com/marcelo-ochoa/jsoncrack-docker-extension/issues)** using the respective
template.

We aim to respond to your issues and questions soonest. If you wish to receive a
faster response, we recommend you always describe your steps and provide
information about your environment in the bug reports. And if you're proposing a
new feature, it'll help us to evaluate the priority if you explain why you need
it.

## Environment setup

- Fork [this](https://github.com/marcelo-ochoa/jsoncrack-docker-extension.git) repository.
- Clone your forked copy of the project to a local environment.
- Always merge commits from the upstream repository to your master branch to keep it updated.
use

```bash
git pull upstream master
```

- Always create a new branch for changes, use

```bash
git checkout -b <your_branch_name>
```

- commit your changes
- push your changes and raise a PR
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docker Extension
# JSONCrack Docker Extension

JSON Crack extension for Docker Desktop, an integration of [jsoncrack.com](https://jsoncrack.com) tool.

Expand All @@ -21,7 +21,7 @@ Extension "JSON Crack" installed successfully

**Note**: Docker Extension CLI is required to execute above command, follow the instructions at [Extension SDK (Beta) -> Prerequisites](https://docs.docker.com/desktop/extensions-sdk/#prerequisites) page for instructions on how to add it.

## Using JSON Crack Docker Extension
## Using JSONCrack Docker Extension

Once the extension is installed a new extension is listed at the pane Extension (Beta) of Docker Desktop.

Expand All @@ -39,11 +39,11 @@ By clicking on Import Icon (left side menu) you can upload a new JSON Document

![Upload Document](docs/images/screenshot4.png?raw=true)

## JsonCrack README
## JSONCrack README

Please read JsonCrack [README.md](https://github.com/AykutSarac/jsoncrack.com/blob/main/README.md) file

## JsonCrack LICENSE
## JSONCrack LICENSE

Please read JsonCrack [LICENSE](https://github.com/AykutSarac/jsoncrack.com/blob/main/LICENSE) file

Expand Down

0 comments on commit 2019769

Please sign in to comment.