fix(docs): wrap markdown lines to 80 chars for MD013 compliance

This commit is contained in:
TimInTech committed 2025-11-02 16:29:07 +01:00
1 parent 79bd8bf146
commit 4c549fe501
4 files changed
+75 -40

No files matched your search

+2 -2
View File
@@ -3,8 +3,8 @@
# Line length
MD013:
line_length: 120
heading_line_length: 120
line_length: 80
heading_line_length: 80
code_blocks: false
# Inline HTML allowed
+44 -20
View File
@@ -2,7 +2,11 @@
## Our Pledge
We pledge to make participation in the project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to make participation in the project and community a harassment-free
experience for everyone, regardless of age, body size, visible or invisible
disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
@@ -19,41 +23,61 @@ Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances.
- Trolling, insulting or derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' private information, such as a physical or email address, without their explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.
- Publishing others' private information, such as a physical or email address,
without their explicit permission.
- Other conduct which could reasonably be considered inappropriate in a
professional setting.
## Enforcement Responsibilities
Project maintainers are responsible for clarifying and enforcing the standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
Project maintainers are responsible for clarifying and enforcing the standards
of acceptable behavior and will take appropriate and fair corrective action in
response to any behavior they deem inappropriate, threatening, offensive, or
harmful.
## Scope
This Code of Conduct applies within project spaces and in public spaces when an individual is representing the project or its community.
This Code of Conduct applies within project spaces and in public spaces when an
individual is representing the project or its community.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at `conduct@timintech.com`. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project team at `conduct@timintech.com`. All complaints will be
reviewed and investigated promptly and fairly.
## Enforcement Guidelines
Maintainers will follow these guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Maintainers will follow these guidelines in determining the consequences for any
action they deem in violation of this Code of Conduct:
1. **Correction**
Community impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
1. **Correction**
Community impact: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
Consequence: A private, written warning from project maintainers, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
2. **Warning**
Community impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code, for a specified period of time.
2. **Warning**
Community impact: A violation through a single incident or series of
actions.
Consequence: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code, for a specified period of time.
3. **Temporary Ban**
Community impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community.
3. **Temporary Ban**
Community impact: A serious violation of community standards, including
sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public
communication with the community.
4. **Permanent Ban**
Community impact: Demonstrating a pattern of violation or harassment, or showing aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
4. **Permanent Ban**
Community impact: Demonstrating a pattern of violation or harassment, or
showing aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org), version 2.1.
+17 -12
View File
@@ -4,27 +4,30 @@ Thanks for your interest in improving `proxmox-manager`!
## How to Contribute
1. **Discuss first**
Open an issue before starting major work so we can align on scope, approach, and ownership.
1. **Discuss first**
Open an issue before starting major work so we can align on scope, approach,
and ownership.
2. **Fork and branch**
Create a topic branch from `main`. Use descriptive branch names such as `feature/json-output` or `fix/spice-port`.
2. **Fork and branch**
Create a topic branch from `main`. Use descriptive branch names such as
`feature/json-output` or `fix/spice-port`.
3. **Style and tooling**
3. **Style and tooling**
- Shell scripts must pass `shellcheck` and `shfmt -w -i 2 -ci -sr`.
- Markdown should be wrapped at 100 columns when practical.
- Follow the `.editorconfig` settings.
4. **Testing**
- Exercise the script on a Proxmox test host or mock environment when possible.
- Add automated tests once the project includes test harnesses.
- Document manual testing steps in the pull request description.
4. **Testing**
- Exercise the script on a Proxmox test host or mock environment when
possible.
- Add automated tests once the project includes test harnesses.
- Document manual testing steps in the pull request description.
5. **Commit standards**
5. **Commit standards**
- Keep commits focused and atomic.
- Reference GitHub issues using `Fixes #123` when applicable.
6. **Pull Request checklist**
6. **Pull Request checklist**
- [ ] `./install_dependencies.sh` ran successfully (if relevant).
- [ ] `shellcheck` and `shfmt` pass locally.
- [ ] Documentation updated for behavior changes (`README.md`, `docs/`).
@@ -32,4 +35,6 @@ Thanks for your interest in improving `proxmox-manager`!
## Releasing
Releases are drafted automatically via GitHub Release Drafter. Tagging `vX.Y.Z` on `main` will create a GitHub release. See `.github/release-drafter.yml` for configuration details.
Releases are drafted automatically via GitHub Release Drafter. Tagging
`vX.Y.Z` on `main` will create a GitHub release. See
`.github/release-drafter.yml` for configuration details.
+12 -6
View File
@@ -6,13 +6,19 @@
| ------- | --------- |
| main | ✅ |
All unreleased changes merged into `main` are expected to pass the automated sanity workflows described in `.github/workflows/`.
All unreleased changes merged into `main` are expected to pass the automated
sanity workflows described in `.github/workflows/`.
## Reporting a Vulnerability
1. **Do not open a public issue.** Instead, send an email to `security@timintech.com` with the subject `proxmox-manager vulnerability`.
2. Provide a clear description, including reproduction steps, impact, and suggested mitigation if available.
3. You will receive an acknowledgement within 72 hours. We aim to provide a remediation or mitigation plan within 14 days.
4. Once a fix is available, we will coordinate disclosure timing with you before publishing a security advisory.
1. **Do not open a public issue.** Instead, send an email to
`security@timintech.com` with the subject `proxmox-manager vulnerability`.
2. Provide a clear description, including reproduction steps, impact, and
suggested mitigation if available.
3. You will receive an acknowledgement within 72 hours. We aim to provide a
remediation or mitigation plan within 14 days.
4. Once a fix is available, we will coordinate disclosure timing with you
before publishing a security advisory.
If you need to transmit sensitive data, ask for a PGP key in your initial email.
If you need to transmit sensitive data, ask for a PGP key in your initial
email.