Skip to content

Commit e447a16

Browse files
authored
Fix typos and markdown issues
1 parent 5cc86c8 commit e447a16

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

CONTRIBUTING.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ following restrictions:
2727
respect the opinions of others.
2828

2929

30-
##Before submitting an issue##
30+
## Before submitting an issue
3131

3232
1. Upgrade to the latest version of MySQLTuner and see if the problem remains
3333

@@ -47,7 +47,7 @@ Good bug reports are extremely helpful — thank you!
4747

4848
Guidelines for bug reports:
4949

50-
1. **Use the [GitHub issue search](https://github.com/major/MySQLTuner-perl/search?type=Issues)** — check if the issue has already been
50+
1. **Use the [GitHub issue search]** — check if the issue has already been
5151
reported.
5252

5353
2. **Check if the bug has already been fixed** — try to reproduce it using the
@@ -100,13 +100,13 @@ to MySQLTuner will be evaluated on a combination of scope (how well it fits into
100100
project), maintenance burden and general usefulness.
101101

102102
Creating something great often means saying no to seemingly good ideas. Don't
103-
dispair if your feature request isn't accepted, take action! Fork the
103+
despair if your feature request isn't accepted, take action! Fork the
104104
repository, build your idea and share it with others. We released MySQLTuner under
105105
the MIT License for this purpose precisely. Open source works best when smart
106106
and dedicated people riff off of each others' ideas to make even greater things.
107107

108-
## New feature request ##
109-
* You can find Enhancement asked by community at [Enhancement issue](https://github.com/major/MySQLTuner-perl/labels/enhancement)
108+
## New feature request
109+
You can find Enhancement asked by community at [Enhancement issue]
110110

111111
<a name="pull-requests"></a>
112112
## Pull requests
@@ -153,8 +153,7 @@ these guidelines is the best way to get your work included in MySQLTuner.
153153
git checkout -b <topic-branch-name>
154154
```
155155

156-
4. Commit your changes in logical chunks. Please adhere to these [git commit
157-
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
156+
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines]
158157
or your code is unlikely be merged into the main project. Use Git's
159158
[interactive rebase](https://help.github.com/articles/interactive-rebase)
160159
feature to tidy up your commits before making them public.
@@ -171,18 +170,23 @@ these guidelines is the best way to get your work included in MySQLTuner.
171170
git push origin <topic-branch-name>
172171
```
173172

174-
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
175-
with a clear title and description.
173+
7. [Open a Pull Request] with a clear title and description.
176174

177175
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
178-
license your work under the [GPLv3 License](https://en.wikipedia.org/wiki/GNU_General_Public_License).
176+
license your work under the [GPLv3 License].
179177

180-
Copy of the license is available at [LICENSE](https://github.com/major/MySQLTuner-perl/blob/master/LICENSE)
178+
Copy of the license is available at [LICENSE]
181179

182180
<a name="code-conventions"></a>
183-
#### MySQLTuner Code Conventions
181+
## MySQLTuner Code Conventions
184182

185183
1. Check code convention using **perltidy** and **perlcritic**
186184
2. Don't manually update the version number in `mysqltuner.pl`.
187-
188185

186+
187+
[Enhancement issue]:https://github.com/major/MySQLTuner-perl/labels/enhancement
188+
[GitHub issue search]:https://github.com/major/MySQLTuner-perl/search?type=Issues
189+
[git commit message guidelines]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
190+
[Open a Pull Request]:https://help.github.com/articles/using-pull-requests/
191+
[GPLv3 License]:https://en.wikipedia.org/wiki/GNU_General_Public_License
192+
[LICENSE]:https://github.com/major/MySQLTuner-perl/blob/master/LICENSE

0 commit comments

Comments
 (0)