Skip to content

Commit a540c33

Browse files
Documentation
1 parent 018e5f8 commit a540c33

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

CONTRIBUTING.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing
22

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.
54

65
## Submission context
76

@@ -26,7 +25,7 @@ a Pull Request with a fix. However, before doing so, please read the
2625

2726
You can request a new feature by submitting an issue to our GitHub Repository.
2827
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
3029
Material for MkDocs is highly opinionated. Please consider what kind of change
3130
it is:
3231

@@ -42,11 +41,11 @@ it is:
4241

4342
### Missing translations?
4443

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
4645
contributions. When new features are added, sometimes, new translations are
4746
necessary as well. It's impossible for the maintainers of the project to update
4847
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
5049
simple, so if you find a translation missing in your language, follow these
5150
guidelines:
5251

@@ -58,14 +57,14 @@ guidelines:
5857
translations that are different from the defaults, e.g. if your language
5958
is left-to-right, don't add the `direction` translation, as English is
6059
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:
6362

6463
- `search.config.lang`
6564
- `search.config.pipeline`
6665
- `search.config.separator`
6766

68-
1. Create a PR (see below) with your changes.
67+
3. Create a PR (see below) with your changes.
6968

7069
[translation file for your language]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages
7170
[English translations]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages/en.html
@@ -75,16 +74,16 @@ guidelines:
7574
### Submitting an issue
7675

7776
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
7978
readily available.
8079

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
8382
systematically ask you to provide a minimal reproduction scenario using the
8483
custom issue template. Please stick to the issue template.
8584

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.
8887

8988
### Submitting a Pull Request (PR)
9089

@@ -96,9 +95,9 @@ go ahead.
9695
make your changes in a separate git branch and add descriptive messages to
9796
your commits.
9897

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.
102101

103102
3. **Pull Request**: After building the theme, commit the compiled output,
104103
push your branch to GitHub and send a PR to `mkdocs-material:master`. If we

0 commit comments

Comments
 (0)