Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update contributing.md #1234

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# Contributing

Please read the following document.
Please read [OSS Contribution Guide](https://github.com/suzuki-shunsuke/oss-contribution-guide).

- https://github.com/suzuki-shunsuke/oss-contribution-guide
## Set up

Requirements:

- Node.js
- aqua

```sh
aqua i -l
```

### Commit Signing

https://github.com/suzuki-shunsuke/oss-contribution-guide/blob/main/docs/commit-signing.md

## Run the document

```sh
npm i
npm start
```

## Check typo using typos

https://github.com/crate-ci/typos

```sh
typos -w .
```

If the fix by typos is wrong, please fix [_typos.toml](_typos.toml).

## Update Usage

1. Update aqua to the latest version.
2. Run `cmdx usage`

```sh
aqua upa
cmdx usage
```
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,12 @@ Website of [aqua](https://github.com/aquaproj/aqua).

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

Images in [the top page](https://aquaproj.github.io/) were generated with [carbon](https://carbon.now.sh/).
Images in [the top page](https://aquaproj.github.io/) were generated using [carbon](https://carbon.now.sh/).

### Local Development
## Contributing

Set up.
[Please see CONTRIBUTING.md](CONTRIBUTING.md).

```console
$ npm i
```
## LICENSE

Start a local development server.

```console
$ npm start
```
[MIT](LICENSE)
3 changes: 3 additions & 0 deletions cmdx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ tasks:
short: l
description: Check if links are broken
usage: Check if links are broken
require:
exec:
- lychee
script: |
set -euo pipefail
git ls-files | grep -E "\.md$" | xargs -n 10 lychee
Expand Down