Skip to content

Commit 8cb3a84

Browse files
fix(docs): resolve markdown lint and link errors
- auto-fix blanks-around-lists and blanks-around-fences violations - add LICENSE.md and ISSUE_TEMPLATE.md to lint ignores - fix line length and emphasis-as-heading in README - update Azure CLI URL to learn.microsoft.com 📝 - Generated by Copilot # Conflicts: # .github/ISSUE_TEMPLATE.md # README.md
1 parent e6a4b28 commit 8cb3a84

File tree

5 files changed

+94
-254
lines changed

5 files changed

+94
-254
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,24 @@ Items in **HIGHEST PRIORITY** sections from attached instructions files override
1313
**Artifacts:** Do not create or modify tests, scripts, or one-off markdown docs unless explicitly requested.
1414

1515
**Comment policy:** Never include thought processes, step-by-step reasoning, or narrative comments in code.
16+
1617
* Keep comments brief and factual; describe **behavior/intent, invariants, edge cases**.
1718
* Remove or update comments that contradict the current behavior. Do not restate obvious functionality.
1819
* Do NOT add temporal or plan-phase markers (e.g. "Phase 1 cleanup", "... after migration", dates, or task references) to code files. When editing or updating any code files, always remove or replace these types of comments.
1920

2021
**Conventions and Styling:** Always follow conventions and styling in this codebase FIRST for all changes, edits, updates, and new files.
22+
2123
* Conventions and styling are in instruction files and must be read in with the `read_file` tool if not already added as an `<attachment>`.
2224

2325
**Proactive fixes:** Always fix problems and errors you encounter, even if unrelated to the original request. Prefer root-cause, constructive fixes over symptom-only patches.
26+
2427
* Always correct all incorrect or problematic conventions, styling, and redundant and/or misleading comments.
2528

2629
**Deleting files and folders:** Use `rm` with the run_in_terminal tool when needing to delete files or folders.
2730

2831
**Edit tools:** Never use `insert_edit_into_file` tool when other edit and file modification tools are available.
2932

3033
**Memory and tracking work**: Always track work in Beads instead of Markdown.
34+
3135
* All upcoming work, tracked work, issues, plans, todos, phases, tasks, and memory must always use the mcp_beads tools.
3236
* Don't ever use git commands for anything related to the mcp_beads tools and beads in general, its at the user's discretion when to use git commands and tools.

.github/instructions/commit-message.instructions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Scopes MUST be one of the following:
3838
- `(src)`
3939
- `(deploy)`
4040

41-
4241
## Description
4342

4443
- Description MUST be short and LESS THAN 100 bytes
@@ -62,7 +61,7 @@ For larger changes only:
6261

6362
- Footer MUST start with a blank line
6463
- Must include an emoji that represents the change
65-
- Must end with ` - Generated by Copilot`
64+
- Must end with `- Generated by Copilot`
6665

6766
## Example Complete Commit Message - Large
6867

.markdownlint-cli2.jsonc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"ignores": [
33
"**/node_modules/**",
44
".copilot-tracking/**",
5-
"venv/**"
5+
"venv/**",
6+
"LICENSE.md"
67
],
78
"config": {
89
"default": true,

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE
21+
SOFTWARE

0 commit comments

Comments
 (0)