From a540c332f609a1d3ccebd06acb40c197cb8b8b39 Mon Sep 17 00:00:00 2001 From: katharinalisalin Date: Thu, 10 Nov 2022 18:50:58 +0100 Subject: [PATCH] Documentation --- CONTRIBUTING.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bede912c..3ed2fa22e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,6 @@ # Contributing -Interested in contributing to the Material for MkDocs? Want to report a bug? -Have a question? Before you do, please read the following guidelines. +Interested in contributing to the Material for MkDocs? Have a question? Want to report a bug? Before you do, please read the following guidelines. ## Submission context @@ -26,7 +25,7 @@ a Pull Request with a fix. However, before doing so, please read the You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a -proposal for your work first, to be sure that it is of use for everyone, as +proposal for your work first to be sure that it is of use to everyone, as Material for MkDocs is highly opinionated. Please consider what kind of change it is: @@ -42,11 +41,11 @@ it is: ### Missing translations? -Material for MkDocs ships support for 50+ languages with the help of community +Material for MkDocs supports 50+ languages with the help of community contributions. When new features are added, sometimes, new translations are necessary as well. It's impossible for the maintainers of the project to update all translations (we just don't speak 50+ languages), so we have to rely on -our contributors to incrementally update translations. This process is pretty +our contributors to update translations incrementally. This process is pretty simple, so if you find a translation missing in your language, follow these guidelines: @@ -58,14 +57,14 @@ guidelines: translations that are different from the defaults, e.g. if your language is left-to-right, don't add the `direction` translation, as English is left-to-right as well. The following translations are for technical - purposes, and should not be updated, so if they're missing from your - language it's for good reason: + purposes and should not be updated, so if they're missing from your + language, it's for good reason: - `search.config.lang` - `search.config.pipeline` - `search.config.separator` -1. Create a PR (see below) with your changes. +3. Create a PR (see below) with your changes. [translation file for your language]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages [English translations]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages/en.html @@ -75,16 +74,16 @@ guidelines: ### Submitting an issue Before you submit an issue, please search the issue tracker, maybe an issue for -your problem already exists and the discussion might inform you of workarounds +your problem already exists, and the discussion might inform you of workarounds readily available. -We want to fix all the issues as soon as possible, but before fixing a bug we -need to reproduce and confirm it. In order to reproduce bugs we will +We want to fix all the issues as soon as possible, but before fixing a bug, we +need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using the custom issue template. Please stick to the issue template. -Unfortunately we are not able to investigate / fix bugs without a minimal -reproduction scenario, so if we don't hear back from you we may close the issue. +Unfortunately, we are not able to investigate / fix bugs without a minimal +reproduction scenario, so if we don't hear back from you, we may close the issue. ### Submitting a Pull Request (PR) @@ -96,9 +95,9 @@ go ahead. make your changes in a separate git branch and add descriptive messages to your commits. -2. **Build**: Before submitting a pull requests, [build the theme]. This is - a mandatory requirement for your PR to get accepted, as the theme should at - all times be installable through GitHub. +2. **Build**: Before submitting a pull request, [build the theme]. This is + a mandatory requirement for your PR to get accepted, as the theme should be installable through GitHub at + all times. 3. **Pull Request**: After building the theme, commit the compiled output, push your branch to GitHub and send a PR to `mkdocs-material:master`. If we