Skip to content

Commit 35e73ae

Browse files
committed
Lint .md files
1 parent 936b3e7 commit 35e73ae

File tree

1 file changed

+57
-18
lines changed

1 file changed

+57
-18
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,81 @@
44
[pr]: https://github.com/actions/ai-inference/compare
55
[code-of-conduct]: CODE_OF_CONDUCT.md
66

7-
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
Hi there! We're thrilled that you'd like to contribute to this project. Your
8+
help is essential for keeping it great.
89

9-
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
10+
Contributions to this project are
11+
[released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
12+
to the public under the [project's open source license](LICENSE).
1013

11-
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
14+
Please note that this project is released with a [Contributor Code of
15+
Conduct][code-of-conduct]. By participating in this project you agree to abide
16+
by its terms.
1217

1318
## Found a bug?
1419

15-
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/actions/ai-inference/issues).
16-
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/actions/ai-inference/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or a **reproducible test case** demonstrating the expected behavior that is not occurring.
20+
- **Ensure the bug was not already reported** by searching on GitHub under
21+
[Issues](https://github.com/actions/ai-inference/issues).
22+
- If you're unable to find an open issue addressing the problem,
23+
[open a new one](https://github.com/actions/ai-inference/issues/new). Be sure
24+
to include a **title and clear description**, as much relevant information as
25+
possible, and a **code sample** or a **reproducible test case** demonstrating
26+
the expected behavior that is not occurring.
1727
- If possible, use the relevant bug report templates to create the issue.
1828

1929
## What should I know before submitting a pull request or issue
2030

21-
This project is written in [TypeScript](https://www.typescriptlang.org/), a typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get a consistent code style.
31+
This project is written in [TypeScript](https://www.typescriptlang.org/), a
32+
typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get
33+
a consistent code style.
2234

23-
Because of how GitHub Actions are run, the source code of this project is transpiled from TypeScript into JavaScript. The transpiled code (found in `lib/`) is subsequently compiled using [NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to avoid having to include the `node_modules/` directory in the repository.
35+
Because of how GitHub Actions are run, the source code of this project is
36+
transpiled from TypeScript into JavaScript. The transpiled code (found in
37+
`lib/`) is subsequently compiled using
38+
[NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to
39+
avoid having to include the `node_modules/` directory in the repository.
2440

2541
## Submitting a pull request
2642

2743
1. [Fork][fork] and clone the repository
2844
1. Configure and install the dependencies: `npm install`
2945
1. Create a new branch: `git checkout -b my-branch-name`
30-
1. Make your change, add tests, and make sure the tests still pass: `npm run test`
46+
1. Make your change, add tests, and make sure the tests still pass:
47+
`npm run test`
3148
1. Make sure your code is correctly formatted: `npm run format`
32-
1. Update `dist/index.js` using `npm run build`. This creates a single javascript file that is used as an entrypoint for the action
49+
1. Update `dist/index.js` using `npm run build`. This creates a single
50+
javascript file that is used as an entrypoint for the action
3351
1. Push to your fork and [submit a pull request][pr]
34-
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
52+
1. Pat yourself on the back and wait for your pull request to be reviewed and
53+
merged.
3554

36-
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
55+
Here are a few things you can do that will increase the likelihood of your pull
56+
request being accepted:
3757

3858
- Write tests.
39-
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
59+
- Keep your change as focused as possible. If there are multiple changes you
60+
would like to make that are not dependent upon each other, consider submitting
61+
them as separate pull requests.
4062

4163
## Releasing a new version
4264

43-
All the concepts from [the actions/toolkit release docs](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md) apply. Please read that first!
65+
All the concepts from
66+
[the actions/toolkit release docs](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md)
67+
apply. Please read that first!
4468

4569
Once the changes are merged into main, a repo maintainer should:
4670

47-
1. Bump the package version by running [`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version). We adhere to [SemVer 2.0](https://semver.org/spec/v2.0.0.html) to the best of our ability. Commit the changes to `package.json` and `package-lock.json` and push them to main.
48-
1. [Draft a new release](https://github.com/actions/ai-inference/releases/new) pointing to the ref of the version bump you just made. Publish the release to the marketplace when complete.
49-
1. Finally: update the corresponding "major tag" (v1, v2, v3, etc) to point to the specific ref of the release you just made. For example, if we just released `v1.1.0`, we would rewrite the `v1` tag like this:
71+
1. Bump the package version by running
72+
[`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version).
73+
We adhere to [SemVer 2.0](https://semver.org/spec/v2.0.0.html) to the best of
74+
our ability. Commit the changes to `package.json` and `package-lock.json` and
75+
push them to main.
76+
1. [Draft a new release](https://github.com/actions/ai-inference/releases/new)
77+
pointing to the ref of the version bump you just made. Publish the release to
78+
the marketplace when complete.
79+
1. Finally: update the corresponding "major tag" (v1, v2, v3, etc) to point to
80+
the specific ref of the release you just made. For example, if we just
81+
released `v1.1.0`, we would rewrite the `v1` tag like this:
5082

5183
```
5284
git tag -fa v1 v1.1.0 -m "Update v1 tag to point to v1.1.0"
@@ -55,7 +87,14 @@ git push origin v1 --force
5587

5688
## Licensed
5789

58-
This repository uses a tool called [Licensed](https://github.com/github/licensed) to verify third party dependencies. You may need to locally install licensed and run `licensed cache` to update the dependency cache if you install or update a production dependency. If licensed cache is unable to determine the dependency, you may need to modify the cache file yourself to put the correct license. You should still verify the dependency, licensed is a tool to help, but is not a substitute for human review of dependencies.
90+
This repository uses a tool called
91+
[Licensed](https://github.com/github/licensed) to verify third party
92+
dependencies. You may need to locally install licensed and run `licensed cache`
93+
to update the dependency cache if you install or update a production dependency.
94+
If licensed cache is unable to determine the dependency, you may need to modify
95+
the cache file yourself to put the correct license. You should still verify the
96+
dependency, licensed is a tool to help, but is not a substitute for human review
97+
of dependencies.
5998

6099
## Resources
61100

@@ -66,4 +105,4 @@ This repository uses a tool called [Licensed](https://github.com/github/licensed
66105

67106
Thanks! :heart: :heart: :heart:
68107

69-
GitHub Actions Team :octocat:
108+
GitHub Actions Team :octocat:

0 commit comments

Comments
 (0)