Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jackdewinter committed Apr 18, 2024
1 parent dfbeb35 commit ea053d0
Show file tree
Hide file tree
Showing 32 changed files with 2,560 additions and 425 deletions.
61 changes: 61 additions & 0 deletions .github/BUG-REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## Prerequisites

* [ ] Are you running the latest version of this application?
* [ ] Have you checked the [Frequently Asked Questions](https://github.com/jackdewinter/pymarkdown/blob/main/docs/faq.md) document?
* [ ] Have you simplified the bug report to the essential details?
* [ ] Do you have a distinct command line to report?
* [ ] Can you clearly state the configuration for this bug report?
* [ ] Do you have a minimal document that highlights this bug?
* [ ] Are any required files (configuration or Markdown document) attached to the issue?
* [ ] Did you perform a cursory search of other issues to look for related issues?

## Bug Report

Please replace any of `[these areas]` in the paragraphs below with the requested information.

### Bug Type

* [ ] Assertion Failure
* [ ] Documentation
* [ ] Scan/Rule not working as expected
* [ ] Fix/Rule not working as expected
* [ ] Other
[Other reason]

### Description

[Provide a concise description of what the issue is.]

### Specifics

What operating system and version are you running into this behavior on?

[Provide Operating System and Version Number]

What version are you seeing this behavior in? (Run `pip list` or `pipenv run pip list` and look for the entry beside `pymarkdownlnt`.)

[PyMarkdownLnt Version Number]

Are there any extra steps that need to be taken before executing the application?

[Any non-standard requirements?]

What is the command line you invoke to get this behavior?

[Assume that anything up to the first `pymarkdown` or `pymarkdownlnt` is already provided.]

Are you using a configuration file? Either on the command line or one of the implicit configuration files? If so, attach that file to this issue.

[Attach any configuration files that would alter processing behavior.]

What Markdown document causes this behavior to manifest? Attach that file to this issue.

[Attach a minimal Markdown document that makes this behavior occur.]

### Actual Behavior

[Describe what behavior was seen when the specifics for executing the application were applied.]

### Expected Behavior

[Describe the behavior that you believe should occur instead of the Actual Behavior. Include any specifics on why that behavior is more correct.]
21 changes: 21 additions & 0 deletions .github/FEATURE-REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Prerequisites

* [ ] Are you running the latest version of this application?
* [ ] Have you checked the [Frequently Asked Questions](https://github.com/jackdewinter/pymarkdown/blob/main/docs/faq.md) document?
* [ ] Did you perform a cursory search of other issues to look for related issues?

## Feature Request

Please replace any of `[these areas]` in the paragraphs below with the requested information.

### Description

[Provide a concise description of what the requested feature is.]

### Desired Behavior of Feature

[Provide a clear picture of the feature you would like to see added, including specific scenarios or contexts where this feature would be particularly useful. Markdown document samples, use cases, and other references will help you convey the necessity and impact your feature.]

### What Are the Benefits of This Feature?

[How many users do you believe will benefit from this feature? How will it impact them?]
21 changes: 10 additions & 11 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:

- name: Install PipEnv
run: |
pip install pipenv==2022.1.8
pip install pipenv==2023.12.1
- name: Sync With Repository
run: |
Expand Down Expand Up @@ -91,22 +91,21 @@ jobs:

- name: Install PipEnv
run: |
pip install pipenv==2022.1.8
pip install pipenv==2023.12.1
- name: Sync With Repository
run: |
pipenv update -d
pipenv graph
- name: Execute PyMarkdown on Docs
- name: Execute PyMarkdown on NewDocs
run: |
cd newdocs
pipenv run python ../main.py scan src
pipenv run python main.py --config newdocs/clean.json scan newdocs/src
- name: Execute MdFormat on Docs
run: |
cd newdocs
pipenv run mdformat --align-semantic-breaks-in-lists --wrap 80 --check .
# - name: Execute MdFormat on Docs
# run: |
# cd newdocs
# pipenv run mdformat --align-semantic-breaks-in-lists --wrap 80 --check .

scenario-tests:

Expand All @@ -130,7 +129,7 @@ jobs:

- name: Install PipEnv
run: |
pip install pipenv==2022.1.8
pip install pipenv==2023.12.1
- name: Sync With Repository
run: |
Expand Down Expand Up @@ -177,7 +176,7 @@ jobs:

- name: Install PipEnv
run: |
pip install pipenv==2022.1.8
pip install pipenv==2023.12.1
- name: Sync With Repository
run: |
Expand Down
Loading

0 comments on commit ea053d0

Please sign in to comment.