diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 00000000000..e42d18e03da --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,38 @@ +# +# An example .markdownlint-cli2.yaml file +# + +# Disable some built-in rules +config: + default: true + + # The same headline in different nested sections is okay (and necessary for + # CHANGELOG.md). + no-duplicate-header: + allow_different_nesting: true + + # We use ordered lists to make stuff easier to read in a text editor. + ol-prefix: + style: ordered + + # Not wrapping long lines makes diffs easier to read, especially for prose. + # Instead, we should follow the "one sentence per line" pattern. + line-length: false + + # Dollar signs are useful to indicate shell commands/type and help + # distinguishing wrapped lines from new commands. + commands-show-output: false + + # Indented code blocks are easier to read in a text editor, but don't allow + # specifying a language for syntax highlighting. Therefore both indented and + # fenced code block should be allowed depending on the use case. + code-block-style: false + +# Fix any fixable errors +fix: true + +# Disable inline config comments +noInlineConfig: true + +# Disable progress on stdout (only valid at root) +noProgress: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 86f4de74ed0..19512186892 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,21 +2,6 @@ # to manage, install and run git hooks to catch common problems early on. # See https://pre-commit.com/ for details. # -# This adds the following hooks: -# -# - check-case-conflict -# - check-byte-order-marker -# - check-yaml -# - check-json -# - check-xml -# - mixed-line-ending -# - end-of-file-fixer -# - trailing-whitespace -# - no-commit-to-branch -# - eslint -# - clang-format -# - qsscheck -# # If you have Python >= 3.7 and python-pip installed, just run: # # $ pip install --user pre-commit @@ -110,6 +95,10 @@ repos: rev: v0.7.2.1 hooks: - id: shellcheck +- repo: https://github.com/DavidAnson/markdownlint-cli2 + rev: v0.2.0 + hooks: + - id: markdownlint-cli2 - repo: local hooks: - id: qsscheck diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7577cad829d..17fd8e063d2 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -9,11 +9,11 @@ communication initiated in the context of these spaces. Simply put, community discussions should be - * respectful and kind; - * about Mixxx; - * about features and code, not the individuals involved. +* respectful and kind; +* about Mixxx; +* about features and code, not the individuals involved. -## Be respectful and constructive. +## Be respectful and constructive Treat everyone with respect. Build on each other's ideas. Each of us has the right to enjoy our experience and participate without fear of harassment, @@ -23,7 +23,7 @@ communicating with someone in their primary language. We all get frustrated when working on hard problems, but we cannot allow that frustration to turn into personal attacks. -## Speak up if you see or hear something. +## Speak up if you see or hear something You are empowered to politely engage when you feel that you or others are disrespected. The person making you feel uncomfortable may not be aware of what @@ -42,32 +42,34 @@ While all reports will be taken seriously, the Mixxx community managers may not act on complaints that they feel are not violations of this code of conduct. -## We will not tolerate harassment of any kind, including but not limited to: +## No Tolerance for Harassment - * Harassing comments - * Intimidation - * Encouraging a person to engage in self-harm. - * Sustained disruption or derailing of threads, channels, lists, etc. - * Offensive or violent comments, jokes or otherwise - * Inappropriate sexual content - * Unwelcome sexual or otherwise aggressive attention - * Continued one-on-one communication after requests to cease - * Distribution or threat of distribution of people's personally identifying - information, AKA “doxing” +We will not tolerate harassment of any kind, including but not limited to: + +* Harassing comments +* Intimidation +* Encouraging a person to engage in self-harm. +* Sustained disruption or derailing of threads, channels, lists, etc. +* Offensive or violent comments, jokes or otherwise +* Inappropriate sexual content +* Unwelcome sexual or otherwise aggressive attention +* Continued one-on-one communication after requests to cease +* Distribution or threat of distribution of people's personally identifying + information, AKA “doxing” ## Consequences for failing to comply with this policy Consequences for failing to comply with this policy may include, at the sole discretion of the Mixxx community managers: - * a request for an apology; - * a private or public warning or reprimand; - * a temporary ban from the mailing list, blog, Mixxx repository or - organization, or other Mixxx-supported communication group, including - loss of committer status; - * a permanent ban from any of the above, or from all current and future - Mixxx-supported communities, including loss of - committer status. +* a request for an apology; +* a private or public warning or reprimand; +* a temporary ban from the mailing list, blog, Mixxx repository or + organization, or other Mixxx-supported communication group, including + loss of committer status; +* a permanent ban from any of the above, or from all current and future + Mixxx-supported communities, including loss of + committer status. Participants warned to stop any harassing behavior are expected to comply immediately; failure to do so will result in an escalation of consequences. diff --git a/README.md b/README.md index 74a53070905..48369dbd84e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Mixxx + [![GitHub latest tag](https://img.shields.io/github/tag/mixxxdj/mixxx.svg)](https://mixxx.org/download) [![Packaging status](https://repology.org/badge/tiny-repos/mixxx.svg)](https://repology.org/metapackage/mixxx/versions) [![Build status](https://github.com/mixxxdj/mixxx/actions/workflows/build.yml/badge.svg)](https://github.com/mixxxdj/mixxx/actions/workflows/build.yml) diff --git a/packaging/certificates/README.md b/packaging/certificates/README.md index 7e171873c71..3cc4896d9fc 100644 --- a/packaging/certificates/README.md +++ b/packaging/certificates/README.md @@ -1,20 +1,15 @@ - # Key Rotation -# downloads-hostgator.mixxx.org +## downloads-hostgator.mixxx.org SSH access is granted via an RSA key stored in `build/certificates/downloads-hostgator.mixxx.org.key`. To rotate this key, generate a new RSA key with a strong password (e.g. 32 character randomly generated). -``` -ssh-keygen -t rsa -b 4096 -f downloads-hostgator.mixxx.org.key -``` + ssh-keygen -t rsa -b 4096 -f downloads-hostgator.mixxx.org.key Copy the **public** key to `$HOME/.ssh/authorized_keys`, replacing the old file to remove access for the current key. Encrypt the password using `travis encrypt` and update `.travis.yml`. -``` -travis encrypt DOWNLOADS_HOSTGATOR_DOT_MIXXX_DOT_ORG_KEY_PASSWORD=hunter2 -r mixxxdj/mixxx -``` + travis encrypt DOWNLOADS_HOSTGATOR_DOT_MIXXX_DOT_ORG_KEY_PASSWORD=hunter2 -r mixxxdj/mixxx