Skip to content

Commit

Permalink
docs: add contribution guidelines (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
c4spar authored Aug 28, 2020
1 parent 230cac7 commit afe47ff
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 3 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing to Cliffy

First off, thank you for considering contributing to cliffy. Here are a few things you may find helpful.

### Get in touch

- ❓ Ask general support questions on [StackOverflow](https://stackoverflow.com/questions/tagged/cliffy) (using the `cliffy` tag) or in the [chat](https://discord.gg/nktwtG).
- 👨‍💻 Use [issues](https://github.com/c4spar/deno-cliffy/issues/new) to report bugs, request new features and discuss your contributions.
- 💬 Discuss topics in the [chat](https://discord.gg/nktwtG).

### Contributing to development

Before you submit your PR please consider the following guidelines:

- 🕶 Follow Deno's [style guide](https://deno.land/manual/contributing/style_guide#typescript).
- ✨ Make sure to run `deno fmt` before committing.
- 📄 [Conventional Commits](https://conventionalcommits.org) are appreciated.
- ⚙️ Test your changes locally with `deno test -r --allow-env --unstable`.

> If you need any help, feel free to ask!
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

> This project is still under development. Expect breaking changes. If you find a bug or have a feature request feel free to create an issue.
## Modules
## Modules

* **[ansi-escape](ansi-escape/):** Show, hide and move cli cursor, erase output and scroll window.

Expand All @@ -41,3 +41,11 @@
* **[prompt](prompt/):** Create interactive prompts like: checkbox, confirm, input, number, select, etc...

* **[table](table/):** Create cli table's with border, padding, nested table's, etc...

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](CONTRIBUTING.md).

## ❯ License

[MIT](LICENSE)
5 changes: 5 additions & 0 deletions ansi-escape/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@

- [Install](#-install)
- [Usage](#-usage)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -75,6 +76,10 @@ AnsiEscape.from(Deno.stdout)
// ...
```

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

[MIT](../LICENSE)
5 changes: 3 additions & 2 deletions command/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
- [Zsh Completions](#zsh-completions)
- [Generic options and arguments](#-generic-options-and-arguments)
- [Version option](#-version-option)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -1211,9 +1212,9 @@ await new Command()
.parse(Deno.args);
```

## Credits
## Contributing

Benjamin Fischer [@c4spar](https://github.com/c4spar)
Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

Expand Down
5 changes: 5 additions & 0 deletions flags/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
- [Usage](#-usage)
- [Options](#-options)
- [Custom type processing](#-custom-type-processing)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -218,6 +219,10 @@ $ deno run https://deno.land/x/cliffy/examples/flags/custom-option-processing.ts
error: Uncaught Error: Option --foo must be of type float but got: abc
```

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

[MIT](../LICENSE)
5 changes: 5 additions & 0 deletions keycode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
- [API](#-api)
- [KeyCode](#keycode)
- [KeyEvent](#keyevent)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -110,6 +111,10 @@ $ deno run --unstable https://deno.land/x/cliffy/examples/keycode/read-key.ts
* meta: boolean
* shift: boolean

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

[MIT](../../LICENSE)
5 changes: 5 additions & 0 deletions prompt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
- [Custom Prompts](#custom-prompts)
- [API](#-api)
- [Types](#-types)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -581,6 +582,10 @@ The `Checkbox` prompt has all [base options](#base-options) and the following pr

**↑ back to:** [Prompt types](#-types)

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

[MIT](../LICENSE)
5 changes: 5 additions & 0 deletions table/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
- [Row's and Cell's](#rows-and-cells)
- [Colspan and Rowspan](#colspan-and-rowspan)
- [API](#-api)
- [Contributing](#-contributing)
- [License](#-license)

## ❯ Install
Expand Down Expand Up @@ -506,6 +507,10 @@ Get cell row span.

*Return type*: `number`

## ❯ Contributing

Any kind of contribution is welcome! Please take a look at the [contributing guidelines](../CONTRIBUTING.md).

## ❯ License

[MIT](../LICENSE)

0 comments on commit afe47ff

Please sign in to comment.