From e838bee8d0a29d022b61472be9efccf096099130 Mon Sep 17 00:00:00 2001 From: Jack Williams <155615316+jacwil@users.noreply.github.com> Date: Wed, 22 May 2024 00:30:00 -0700 Subject: [PATCH] docs: update broken links in CONTRIBUTING.md (#219) --- templates/repository/common/CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/templates/repository/common/CONTRIBUTING.md b/templates/repository/common/CONTRIBUTING.md index b33e33c..892c9a0 100644 --- a/templates/repository/common/CONTRIBUTING.md +++ b/templates/repository/common/CONTRIBUTING.md @@ -143,10 +143,10 @@ checklist to contribute an example: not get mixed up. 1. Add a descriptive prefix to commits. This ensures a uniform commit history and helps structure the changelog. Please refer to this - [list of prefixes for $PROJECT](https://github.com/$REPOSITORY/blob/master/.github/semantic.yml) - for an overview. + [Convential Commits configuration](https://github.com/$REPOSITORY/blob/master/.github/workflows/conventional_commits.yml) + for the list of accepted prefixes. You can read more about the Conventional Commit specification [at their site](https://www.conventionalcommits.org/en/v1.0.0/). 1. Create a `README.md` that explains how to use the example. (Use - [the README template](https://github.com/ory/examples/blob/master/_common/README)). + [the README template](https://github.com/ory/examples/blob/master/_common/README.md)). 1. Open a pull request and maintainers will review and merge your example. ## Contribute code @@ -171,8 +171,8 @@ request, go through this checklist: 1. Run `make format` 1. Add a descriptive prefix to commits. This ensures a uniform commit history and helps structure the changelog. Please refer to this - [list of prefixes for $PROJECT](https://github.com/$REPOSITORY/blob/master/.github/semantic.yml) - for an overview. + [Convential Commits configuration](https://github.com/$REPOSITORY/blob/master/.github/workflows/conventional_commits.yml) + for the list of accepted prefixes. You can read more about the Conventional Commit specification [at their site](https://www.conventionalcommits.org/en/v1.0.0/). If a pull request is not ready to be reviewed yet [it should be marked as a "Draft"](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).