@catladder/cli 0.0.0-refactor-docker-45f6e733 → 0.0.0-refactor-cache-b38c122b

package/CONTRIBUTING.md

@@ -1,88 +1,5 @@
-### Commit message guidelines
+# Contribution
 
-#### Atomic commits
+[See contribution guide][docs-contribute].
 
-If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means that a commit should:
-
-- Contain exactly one self-contained functional change
-- Not depend on changes in one of your later commits
-- Not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc…)
-
-A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
-
-#### Commit message format
-
-Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
-
-```commit
-<type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-The **header** is mandatory and the **scope** of the header is optional.
-
-The **footer** can contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages).
-
-#### Revert
-
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.  
-In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
-
-#### Type
-
-The type must be one of the following:
-
-| Type         | Description                                                                                                 |
-| ------------ | ----------------------------------------------------------------------------------------------------------- |
-| **build**    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)         |
-| **ci**       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
-| **docs**     | Documentation only changes                                                                                  |
-| **feat**     | A new feature                                                                                               |
-| **fix**      | A bug fix                                                                                                   |
-| **perf**     | A code change that improves performance                                                                     |
-| **refactor** | A code change that neither fixes a bug nor adds a feature                                                   |
-| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc)      |
-| **test**     | Adding missing tests or correcting existing tests                                                           |
-
-#### Subject
-
-The subject contains a succinct description of the change:
-
-- use the imperative, present tense: "change" not "changed" nor "changes"
-- don't capitalize the first letter
-- no dot (.) at the end
-
-#### Body
-
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".  
-The body should include the motivation for the change and contrast this with previous behaviour.
-
-#### Footer
-
-The footer should contain any information about **Breaking Changes** and is also the place to reference GitLab issues that this commit **Closes**.
-
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.  
-The rest of the commit message is then used for this.
-
-#### Examples
-
-```commit
-`fix(pencil): stop graphite breaking when too much pressure applied`
-```
-
-```commit
-`feat(pencil): add 'graphiteWidth' option`
-
-Fix #42
-```
-
-```commit
-perf(pencil): remove graphiteWidth option`
-
-BREAKING CHANGE: The graphiteWidth option has been removed.
-
-The default graphite width of 10mm is always used for performance reasons.
-```
+[docs-contribute]: https://catladder.git.panter.biz/catladder/docs/contribute "Contribution guide"

package/README.md

@@ -1,41 +1,18 @@
 # catladder 🐱 🔧
 
-Panter cli tool for Kubernetes.
+[Panter](https://panter.ch) cli tool for cloud CI/CD and DevOps.
 
-## Install
-
-```sh
-# yarn users
-yarn global add @catladder/cli
-# npm users
-npm install -g @catladder/cli
-```
-
-> **Note**: If you have [@catladder/pipeline](https://www.npmjs.com/package/@catladder/pipeline) installed, upgrade it to >=4.0.0 before installing [@catladder/cli](https://www.npmjs.com/package/@catladder/cli).
+**It just works™**
 
 ## Getting started
 
-You'll need:
-
-- Google Cloud SDK ([see installation instructions](https://cloud.google.com/sdk/docs/install))
-- Kubectl ([see installation instructions](https://kubernetes.io/docs/tasks/tools/))
-- Cloud SQL Auth proxy ([see installation instructions](https://cloud.google.com/sql/docs/postgres/sql-proxy#install))
-
-Afterwards, you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
-In most cases, you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
+[See the documentation][docs-getting-started].
 
-It just works™
-
-## Preferences
-
-Catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
+[docs-getting-started]: https://catladder.git.panter.biz/catladder/docs/getting_started "Getting started"
 
 ## Contribution
 
-Check the documentation [here](https://git.panter.ch/catladder/catladder/-/tree/main/cli/CONTRIBUTING.md).
-
-### Adding packages in cli
+[See contribution guide][docs-contribute].
 
-if you add npm libs in cli, make sure to add them as dev-dependencies.
+[docs-contribute]: https://catladder.git.panter.biz/catladder/docs/contribute "Contribution guide"
 
-the reason is that we bundle all dependencies in the cli package, so that if you add that to your project, it won't install all @catladder/cli's dependencies.