Update readme and add contributing.md
This commit is contained in:
parent
00baa2759e
commit
a91ac6e3ff
|
@ -0,0 +1,33 @@
|
||||||
|
# Welcome!
|
||||||
|
|
||||||
|
This document is for people who want to contribute to this repository!
|
||||||
|
|
||||||
|
## Code Style
|
||||||
|
|
||||||
|
We use [standard.js](https://standardjs.org) with [eslint](https://eslint.org) and [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint).
|
||||||
|
So please don't make as lint errors as possible. There're many rules in standard.js but the highlight things are:
|
||||||
|
|
||||||
|
- Use `camelCase` for function names, variables, etc.
|
||||||
|
- Use `PascalCase` for class names.
|
||||||
|
- Add return types on function. Ex:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const example = (): void => {}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Do not make unused variables or unused imports.
|
||||||
|
|
||||||
|
These are not on standard.js but we want you to follow.
|
||||||
|
|
||||||
|
- Make names to simple but understandable for someone whose English is not a primary language.
|
||||||
|
|
||||||
|
## File Name Style
|
||||||
|
|
||||||
|
Nothing much, but please make it as simple as possible, and in `camelCase`.
|
||||||
|
|
||||||
|
## Submitting PR
|
||||||
|
|
||||||
|
When submitting PR, please make the title as simple as possible. Ex: `[Feature improvement]: Cache can now be loaded much faster`
|
||||||
|
Also, please make it understandable for someone whose English is not a primary language.
|
||||||
|
|
||||||
|
Thanks!
|
53
README.md
53
README.md
|
@ -1,3 +1,52 @@
|
||||||
# discord.deno
|
# discord-deno
|
||||||
|
|
||||||
## Feature
|
![banner](images/discord-deno.png)
|
||||||
|
|
||||||
|
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
|
Discord Deno API that is easy to use
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Docs](#docs)
|
||||||
|
- [Maintainers](#maintainers)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { Client } from 'https://deno.land/x/discord-deno/models/client.ts'
|
||||||
|
import { Message } from 'https://deno.land/x/discord-deno/structures/message.ts'
|
||||||
|
|
||||||
|
const bot = new Client()
|
||||||
|
|
||||||
|
bot.on('messageCreate', (msg: Message): void => {
|
||||||
|
if (msg.content === '!ping') {
|
||||||
|
msg.channel.send(`Pong! ping: ${bot.ping}`)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
bot.connect(TOKEN, [GatewayIntents.GUILD_MESSAGES])
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
|
||||||
|
Not made yet
|
||||||
|
|
||||||
|
## Maintainers
|
||||||
|
|
||||||
|
[@Helloyunho](https://github.com/Helloyunho)
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [the contributing file](CONTRIBUTING.md)!
|
||||||
|
|
||||||
|
PRs accepted.
|
||||||
|
|
||||||
|
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT © 2020 Helloyunho
|
||||||
|
|
Loading…
Reference in New Issue