generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Upgraed dependencies. - Improved governance documentation, mostly by adding it. - Switched from eslint/prettier to Biome. - Included action / version in the output.
- Loading branch information
1 parent
c942a85
commit 84f78c1
Showing
16 changed files
with
656 additions
and
2,454 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Contributing | ||
|
||
We value contributions to @KineticCafe/actions-dco—bug reports, feature | ||
requests, and code contributions. | ||
|
||
Before contributing patches, please read the [Licence.md](./Licence.md). | ||
|
||
@KineticCafe/actions-dco is governed under the Kinetic Commerce Open Source | ||
[Code of Conduct][]. | ||
|
||
## Code Guidelines | ||
|
||
Our usual code contribution guidelines apply: | ||
|
||
- Code changes _will not_ be accepted without tests. The test suite is written | ||
with [vitest][]. | ||
- Match our coding style. We use Biome to assist with this. | ||
- Use a thoughtfully-named topic branch that contains your change. Rebase your | ||
commits into logical chunks as necessary. | ||
- Use [quality commit messages][]. | ||
- The version number must not be changed except as part of the release process. | ||
- Submit a pull request with your changes. | ||
- New or changed behaviours require new or updated documentation. | ||
|
||
A pull request will be accepted only if all code quality checks performed in | ||
GitHub Actions pass. | ||
|
||
@KineticCafe/actions-dco is compiled into a single file with `@vercel/ncc` for | ||
release. One of the status checks is that there are no changes during the | ||
packaging process. Ensure that you run `pnpm all` and commit any files in | ||
`dist/` once you are satisfied with your changes. | ||
|
||
[code of conduct]: https://github.com/KineticCafe/code-of-conduct | ||
[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
[vitest]: https://vitest.dev/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Licence | ||
|
||
@KineticCafe/actions-dco is copyright © 2023-2024 Kinetic Commerce and | ||
contributors under the [Apache License, version 2.0][apache-license-20], except: | ||
|
||
- The copies of the Apache Licence and the Developer Certificate of Origin in | ||
`licenses/`. | ||
|
||
## Developer Certificate of Origin | ||
|
||
All contributors **must** certify they are able and willing to provide their | ||
contributions under the terms of this project's licences with the certification | ||
of the [Developer Certificate of Origin (Version 1.1)][dco]. | ||
|
||
Such certification is provided by ensuring that the following line must be | ||
included as the last line of a commit message for every commit contributed: | ||
|
||
Signed-off-by: FirstName LastName <[email protected]> | ||
|
||
The `Signed-off-by` line can be automatically added by git with the `-s` or | ||
`--signoff` option on `git commit`: | ||
|
||
```sh | ||
git commit --signoff | ||
``` | ||
|
||
[apache-license-20]: licenses/APACHE-2.0.txt | ||
[dco]: licenses/dco.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"$schema": "https://biomejs.dev/schemas/1.5.3/schema.json", | ||
"files": { | ||
"ignore": ["coverage/**", "dist/**", "docs/**", "lib/**"] | ||
}, | ||
"organizeImports": { | ||
"enabled": true | ||
}, | ||
"formatter": { | ||
"enabled": true, | ||
"indentStyle": "space", | ||
"lineWidth": 90 | ||
}, | ||
"javascript": { | ||
"formatter": { | ||
"indentStyle": "space", | ||
"lineWidth": 90, | ||
"quoteStyle": "single", | ||
"semicolons": "asNeeded" | ||
} | ||
}, | ||
"linter": { | ||
"enabled": true, | ||
"rules": { | ||
"recommended": true | ||
} | ||
} | ||
} |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.