Skip to content

Gregsdennis/markdown lint #1549

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.

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

Merged
merged 5 commits into from
Nov 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Thanks for submitting a pull request! Please provide enough information so that
### Issue & Discussion References

<!-- Pick at least one of the below options, and remove those which don't apply. -->
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
- Others? <!-- Add any additional notes or references here -->
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
- Others? <!-- Add any additional notes or references here -->

### Summary

Expand Down
23 changes: 18 additions & 5 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# Reporting Security Issues

The JSON Schema project does not house any implementation of JSON Schema itself. If you have found a security issue in any implementation of JSON Schema, please contact the appropriate maintainers, per the projects security reporting guidelines, if any.
The JSON Schema project does not house any implementation of JSON Schema itself.
If you have found a security issue in any implementation of JSON Schema, please
contact the appropriate maintainers, per the projects security reporting
guidelines, if any.

To report a security issue, please use the GitHub Security Advisory "https://github.com/json-schema-org/json-schema-spec/security/advisories/new" tab.
To report a security issue, please use the GitHub Security Advisory
"<https://github.com/json-schema-org/json-schema-spec/security/advisories/new>"
tab.

If you find a security issue in relation to the JSON Schema specification or another repository within this GitHub organization, please use the above.
If you find a security issue in relation to the JSON Schema specification or
another repository within this GitHub organization, please use the above.

The JSON Schema project TSC will review and respond to all security reports. Please follow [coordinated disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities).
The JSON Schema project TSC will review and respond to all security reports.
Please follow [coordinated disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities).

If you are a maintainer of an implementation, please consider [adding a security
policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository).
If you need assistance in understanding a report, or remediation of a confirmed
issue, please feel free to reach out to us on our Slack server, in the
`#implementations` channel, and ask for a temporary private channel to discuss
your situation or concerns.

If you are a maintainer of an implementation, please consider [adding a security policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository). If you need assistance in understanding a report, or remediation of a confirmed issue, please feel free to reach out to us on our Slack server, in the `#implementations` channel, and ask for a temporary private channel to discuss your situation or concerns.
4 changes: 3 additions & 1 deletion .remarkrc-lint.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import remarkPresetLintMarkdownStyleGuide from "remark-preset-lint-markdown-styl
import remarkLintListItemIndent from "remark-lint-list-item-indent";
import remarkLintListItemSpacing from "remark-lint-list-item-spacing";
import remarkLintNoFileNameMixedCase from "remark-lint-no-file-name-mixed-case";
import remarkLintNoFileNameIrregularCharacters from "remark-lint-no-file-name-irregular-characters";


export default {
Expand All @@ -15,6 +16,7 @@ export default {
remarkPresetLintMarkdownStyleGuide,
[remarkLintListItemIndent, "one"],
[remarkLintListItemSpacing, { checkBlanks: true }],
[remarkLintNoFileNameMixedCase, false]
[remarkLintNoFileNameMixedCase, false],
[remarkLintNoFileNameIrregularCharacters, false]
]
};
10 changes: 10 additions & 0 deletions .remarkrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import remarkGfm from "remark-gfm";
import lintPreset from "./.remarkrc-lint.js";


export default {
plugins: [
remarkGfm,
lintPreset
]
};
58 changes: 42 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,71 @@

## Contributing to JSON Schema Specification

Thanks for taking the time to contribute! 🎉👍
Thanks for taking the time to contribute! 🎉👍

JSON Schema is an evolving language. This repository contains the specification text as well as Pull Requests with suggested improvements and contributions.
JSON Schema is an evolving language. This repository contains the specification
text as well as Pull Requests with suggested improvements and contributions.

Contributions that do not change the interpretation of the spec but instead improve legibility, fix editorial errors, clear up ambiguity and improve examples are encouraged and are often merged by a spec editor with little process.
Contributions that do not change the interpretation of the spec but instead
improve legibility, fix editorial errors, clear up ambiguity and improve
examples are encouraged and are often merged by a spec editor with little
process.

However, contributions that _do_ meaningfully change the interpretation of the spec must follow the Specification Development Process which is ⚠️currently under discussion and development⚠️.
However, contributions that *do* meaningfully change the interpretation of the
spec must follow the [Specification Development Process](./PROCESS.md).

## Issues

Issues should identify a problem, enhancement, or use case; and propose some course of action for the draft. For alternate support channels, see the [SUPPORT.md](https://github.com/json-schema-org/.github/blob/main/SUPPORT.md).
Issues should identify a problem, enhancement, or use case; and propose some
course of action for the draft. For alternate support channels, see the
[SUPPORT.md](https://github.com/json-schema-org/.github/blob/main/SUPPORT.md).

## Pull Requests

We welcome pull requests, both for editorial suggestions and to resolve open issues.
We welcome pull requests, both for editorial suggestions and to resolve open
issues.

If the pull request would solve a particular issue, reference the issue in the pull request description.
If the pull request would solve a particular issue, reference the issue in the
pull request description.

Changes that would affect implementation behavior should typically be opened as an issue first.
Changes that would affect implementation behavior should typically be opened as
an issue first.

Generally, pull requests should be made to the `main` branch unless it is a patch update and we are in a patch phase. In that case there will be a branch named something like `2020-12-patch` that the PR should target instead.
Generally, pull requests should be made to the `main` branch unless it is a
patch update and we are in a patch phase. In that case there will be a branch
named something like `2020-12-patch` that the PR should target instead.

Most PRs, including all PRs that impact implementation behavior, will be left open for a minimum of 14 days. Minor wording fixes may be merged more quickly once approved by a project member.
Most PRs, including all PRs that impact implementation behavior, will be left
open for a minimum of 14 days. Minor wording fixes may be merged more quickly
once approved by a project member.

## Milestones

Each milestone is an estimation of the work that will be done for the next draft. Milestones are typically named after the meta-schema draft number, and the _open_ milestone with the lowest draft number is the current active project.
Each milestone is an estimation of the work that will be done for the next
draft. Milestones are typically named after the meta-schema draft number, and
the *open* milestone with the lowest draft number is the current active project.

Issues may be removed from a milestoned due to lack of consensus, lack of anyone with the correct expertise to make a PR, or simply because we wish to publish a draft and defer the remaining issues to the next draft.
Issues may be removed from a milestoned due to lack of consensus, lack of anyone
with the correct expertise to make a PR, or simply because we wish to publish a
draft and defer the remaining issues to the next draft.

Numbered milestones other than the lowest-numbered one are used to tentatively organize future work, but may be completely reorganized once work on that draft actually begins.
Numbered milestones other than the lowest-numbered one are used to tentatively
organize future work, but may be completely reorganized once work on that draft
actually begins.

The `draft-future` milestone is for issues for which there is an agreement that they should be addressed, but no specific timeline.
The `draft-future` milestone is for issues for which there is an agreement that
they should be addressed, but no specific timeline.

## Code of Conduct

All official channels including the mailing list, GitHub organization and Slack server, follow our [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md).
All official channels including the mailing list, GitHub organization and Slack
server, follow our
[Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md).

## Have Questions?

You can join the `#specification` channel in our [Slack workspace](https://json-schema.org/slack) to interact with other community members involved in the Specification development, share new ideas and ask questions.
You can join the `#specification` channel in our
[Slack workspace](https://json-schema.org/slack) to interact with other
community members involved in the Specification development, share new ideas and
ask questions.

Loading
Loading