Skip to content

contributing: fix header levels #37

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged

contributing: fix header levels #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To install node dependencies, run:
pnpm install
```

### Packaging
## Packaging

The action code is located in `src/`.
After editing the code, run the following command to
Expand All @@ -41,7 +41,7 @@ we added the `dist/` directory to the [`.gitattributes`](.gitattributes) file wi
You can learn more about this in the
[GitHub docs](https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github).

#### Tree-shaking
### Tree-shaking

Unfortunately, a bug in the `"@actions/core"` library prevents
[tree-shaking](https://rollupjs.org/introduction/#tree-shaking) to work.
Expand All @@ -56,7 +56,7 @@ Therefore, it is important that `main.ts` and `post.ts` don't depend on each oth

This issue is tracked in [#5](https://github.com/rust-lang/crates-io-auth-action/issues/5).

### Formatting
## Formatting

We use [Prettier](https://prettier.io/) to format TypeScript, Markdown, and YAML files.
To format all files, run:
Expand All @@ -65,7 +65,7 @@ To format all files, run:
pnpm prettier --write .
```

### Linting
## Linting

We use [ESLint](https://eslint.org/) for linting TypeScript files.

Expand All @@ -75,7 +75,7 @@ To check for linting errors, run:
pnpm eslint
```

### Testing
## Testing

There are two types of tests running in [ci.yml](.github/workflows/ci.yml):

Expand Down