From e7e793aa3779a3fb511bdd2a5382323e77fb3ff8 Mon Sep 17 00:00:00 2001 From: Sean Goedecke Date: Mon, 7 Apr 2025 00:55:53 +0000 Subject: [PATCH] Apply markdown lint fixes --- CODE_OF_CONDUCT.md | 19 ++++++++++--------- CONTRIBUTING.md | 8 ++++---- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 46cdcb2..ecd7937 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -48,18 +48,19 @@ offensive, or harmful. This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official -project e-mail address, posting via an official social media account, or acting +project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at opensource@github.com. All complaints -will be reviewed and investigated and will result in a response that is deemed -necessary and appropriate to the circumstances. The project team is obligated to -maintain confidentiality with regard to the reporter of an incident. Further -details of specific enforcement policies may be posted separately. +reported by contacting the project team at `opensource@github.com`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an +incident. Further details of specific enforcement policies may be posted +separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other @@ -69,9 +70,9 @@ members of the project's leadership. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at -https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +`https://www.contributor-covenant.org/version/1/4/code-of-conduct.html` -[homepage]: https://www.contributor-covenant.org +[homepage]: `https://www.contributor-covenant.org` For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq +`https://www.contributor-covenant.org/faq` \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 419a9e4..2170270 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -## Contributing +# Contributing [fork]: https://github.com/actions/ai-inference/fork [pr]: https://github.com/actions/ai-inference/compare @@ -47,7 +47,7 @@ avoid having to include the `node_modules/` directory in the repository. `npm run test` 1. Make sure your code is correctly formatted: `npm run format` 1. Update `dist/index.js` using `npm run build`. This creates a single - javascript file that is used as an entrypoint for the action + JavaScript file that is used as an entrypoint for the action 1. Push to your fork and [submit a pull request][pr] 1. Pat yourself on the back and wait for your pull request to be reviewed and merged. @@ -66,7 +66,7 @@ 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! -Once the changes are merged into main, a repo maintainer should: +Once the changes are merged into main, a repository maintainer should: 1. Bump the package version by running [`npm version [major|minor|patch]`](https://docs.npmjs.com/cli/v7/commands/npm-version). @@ -80,7 +80,7 @@ Once the changes are merged into main, a repo maintainer should: 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: -``` +```bash git tag -fa v1 v1.1.0 -m "Update v1 tag to point to v1.1.0" git push origin v1 --force ```