Skip to content

fix: resolve markdown formatting issues in documentation #173

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

Closed
Copilot wants to merge 2 commits into from
Closed

fix: resolve markdown formatting issues in documentation #173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0d2f9a
Initial plan
Copilot Oct 30, 2025
bdd32d9
fix: resolve markdown formatting issues
Copilot Oct 30, 2025
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
9 changes: 3 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Before creating a pull request please:
1. Format your code (`dart format .`).
1. Analyze your code (`dart analyze . --fatal-infos`).
1. Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) specification for your commit messages.
- This enables automatic version bumping and changelog generation as detailed in the [Release Process](#release-process-🚀) section.
- This enables automatic version bumping and changelog generation as detailed in the [Release Process](#release-process-) section.

@marcossevilla marcossevilla Oct 30, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot I don't think this change will work, if we remove the emoji, we break the link

1. Create the Pull Request.
1. Verify that all status checks are passing.

Expand Down Expand Up @@ -85,7 +85,7 @@ We use [`release-please-action`][release-please-action-link] to automate version
>- The file `lib/analysis_options_<NEW_VERSION>.yaml` exists
>- If any mismatches are found, the files need to be manually updated to match

##### 💡 Notes
#### 💡 Notes

- The GitHub Action workflow that automates the release process is configured in `.github/workflows/release_please.yaml`
- release-please settings are defined in `.release-please-config.json` and `.release-please-manifest.json`
Expand All @@ -97,10 +97,7 @@ We use [`release-please-action`][release-please-action-link] to automate version
- A GitHub Release is published with the changelog.
- A new version of Very Good Analysis is automatically published in pub.dev.

#### 💡 Notes

- The publishing process is automatically triggered when a version tag is created.
- The automated publishing workflow to pub.dev is defined in `.github/workflows/pub_publish.yaml`
**Note:** The publishing process is automatically triggered when a version tag is created. The automated publishing workflow to pub.dev is defined in `.github/workflows/pub_publish.yaml`

This document provides a good summary of how it works and how we use it, but we recommend that you also read the official documentation of [Conventional Commits][conventional_commits_link], [Semantic Versioning][sem_ver_link], [Publishing Dart packages][dart_publishing_link] and [`release-please-action`][release-please-action-link].

Expand Down