1
1
# Contributing
2
2
3
- Interested in contributing to the Material for MkDocs? Want to report a bug?
4
- Have a question? Before you do, please read the following guidelines.
3
+ Interested in contributing to the Material for MkDocs? Have a question? Want to report a bug? Before you do, please read the following guidelines.
5
4
6
5
## Submission context
7
6
@@ -26,7 +25,7 @@ a Pull Request with a fix. However, before doing so, please read the
26
25
27
26
You can request a new feature by submitting an issue to our GitHub Repository.
28
27
If you would like to implement a new feature, please submit an issue with a
29
- proposal for your work first, to be sure that it is of use for everyone, as
28
+ proposal for your work first to be sure that it is of use to everyone, as
30
29
Material for MkDocs is highly opinionated. Please consider what kind of change
31
30
it is:
32
31
@@ -42,11 +41,11 @@ it is:
42
41
43
42
### Missing translations?
44
43
45
- Material for MkDocs ships support for 50+ languages with the help of community
44
+ Material for MkDocs supports 50+ languages with the help of community
46
45
contributions. When new features are added, sometimes, new translations are
47
46
necessary as well. It's impossible for the maintainers of the project to update
48
47
all translations (we just don't speak 50+ languages), so we have to rely on
49
- our contributors to incrementally update translations. This process is pretty
48
+ our contributors to update translations incrementally . This process is pretty
50
49
simple, so if you find a translation missing in your language, follow these
51
50
guidelines:
52
51
@@ -58,14 +57,14 @@ guidelines:
58
57
translations that are different from the defaults, e.g. if your language
59
58
is left-to-right, don't add the ` direction ` translation, as English is
60
59
left-to-right as well. The following translations are for technical
61
- purposes, and should not be updated, so if they're missing from your
62
- language it's for good reason:
60
+ purposes and should not be updated, so if they're missing from your
61
+ language, it's for good reason:
63
62
64
63
- ` search.config.lang `
65
64
- ` search.config.pipeline `
66
65
- ` search.config.separator `
67
66
68
- 1 . Create a PR (see below) with your changes.
67
+ 3 . Create a PR (see below) with your changes.
69
68
70
69
[ translation file for your language ] : https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages
71
70
[ English translations ] : https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages/en.html
@@ -75,16 +74,16 @@ guidelines:
75
74
### Submitting an issue
76
75
77
76
Before you submit an issue, please search the issue tracker, maybe an issue for
78
- your problem already exists and the discussion might inform you of workarounds
77
+ your problem already exists, and the discussion might inform you of workarounds
79
78
readily available.
80
79
81
- We want to fix all the issues as soon as possible, but before fixing a bug we
82
- need to reproduce and confirm it. In order to reproduce bugs we will
80
+ We want to fix all the issues as soon as possible, but before fixing a bug, we
81
+ need to reproduce and confirm it. In order to reproduce bugs, we will
83
82
systematically ask you to provide a minimal reproduction scenario using the
84
83
custom issue template. Please stick to the issue template.
85
84
86
- Unfortunately we are not able to investigate / fix bugs without a minimal
87
- reproduction scenario, so if we don't hear back from you we may close the issue.
85
+ Unfortunately, we are not able to investigate / fix bugs without a minimal
86
+ reproduction scenario, so if we don't hear back from you, we may close the issue.
88
87
89
88
### Submitting a Pull Request (PR)
90
89
@@ -96,9 +95,9 @@ go ahead.
96
95
make your changes in a separate git branch and add descriptive messages to
97
96
your commits.
98
97
99
- 2 . ** Build** : Before submitting a pull requests , [ build the theme] . This is
100
- a mandatory requirement for your PR to get accepted, as the theme should at
101
- all times be installable through GitHub .
98
+ 2 . ** Build** : Before submitting a pull request , [ build the theme] . This is
99
+ a mandatory requirement for your PR to get accepted, as the theme should be installable through GitHub at
100
+ all times.
102
101
103
102
3 . ** Pull Request** : After building the theme, commit the compiled output,
104
103
push your branch to GitHub and send a PR to ` mkdocs-material:master ` . If we
0 commit comments