Skip to content

Commit

Permalink
docs: launch doc website (#788)
Browse files Browse the repository at this point in the history
  • Loading branch information
tasshi-me authored Jun 20, 2024
1 parent 3f59e05 commit 8b12b7b
Show file tree
Hide file tree
Showing 111 changed files with 3,569 additions and 3,395 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ allure-results
# website package
website/.docusaurus
website/build
## Auto generated file
website/contributors.json
5 changes: 2 additions & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ allure-results
*.html

# Ignore tsconfig file
tsconfig.json
/tsconfig.json

# Ignore auto generated files
pnpm-lock.yaml
Expand All @@ -19,8 +19,7 @@ CHANGELOG.md
## Ignore artifacts:
website/.docusaurus
website/build
## Ignore tsconfig file
website/tsconfig.json
## Ignore auto generated files
website/pnpm-lock.yaml
website/CHANGELOG.md
website/contributors.json
54 changes: 1 addition & 53 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,3 @@
# Contributing Guide

## For Contributors

Contributions are always welcome!
If you have discovered a bug or have a feature request, [please create an issue on GitHub](https://github.com/kintone/cli-kintone/issues/new/choose).
Pull requests are also welcome when you find trivial bugs or typos.

We use English for all commit messages, code comments, issues, pull requests.
For Japanese speakers, we have another repository: https://github.com/kintone/js-sdk-ja.
Please file an issue there.

(Translated in Japanese)
本リポジトリではコミットメッセージやコードコメント、issues、pull requests において英語を使用しています。
日本語話者向けに専用のリポジトリも用意しています: https://github.com/kintone/js-sdk-ja
こちらに issue をご登録ください。

### Setup

```sh
% cd cli-kintone
% yarn install
```

### Develop

```sh
% cd cli-kintone
% yarn start
```

### Test

Before run `lint` and `test` scripts, you have to run `build`.

```sh
% cd cli-kintone
% yarn build
% yarn test
% yarn lint
```

## For Maintainers

### Merge

After you have approved a PR, please merge the PR using **Squash and merge** with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.

```sh
feat: support importing CSV
```

### Release

TODO: Create release pipeline and write document
See [Contributing](https://cli.kintone.dev/community/contributing) page.
Loading

0 comments on commit 8b12b7b

Please sign in to comment.