From e447a16157ec9f97629c5f0b70b76f1bc5b1749b Mon Sep 17 00:00:00 2001 From: Konstantin Date: Mon, 27 Mar 2017 15:33:46 +0300 Subject: [PATCH] Fix typos and markdown issues --- CONTRIBUTING.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e913c2..68fcbaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ following restrictions: respect the opinions of others. -##Before submitting an issue## +## Before submitting an issue 1. Upgrade to the latest version of MySQLTuner and see if the problem remains @@ -47,7 +47,7 @@ Good bug reports are extremely helpful — thank you! Guidelines for bug reports: -1. **Use the [GitHub issue search](https://github.com/major/MySQLTuner-perl/search?type=Issues)** — check if the issue has already been +1. **Use the [GitHub issue search]** — check if the issue has already been reported. 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 project), maintenance burden and general usefulness. Creating something great often means saying no to seemingly good ideas. Don't -dispair if your feature request isn't accepted, take action! Fork the +despair if your feature request isn't accepted, take action! Fork the repository, build your idea and share it with others. We released MySQLTuner under the MIT License for this purpose precisely. Open source works best when smart and dedicated people riff off of each others' ideas to make even greater things. -## New feature request ## -* You can find Enhancement asked by community at [Enhancement issue](https://github.com/major/MySQLTuner-perl/labels/enhancement) +## New feature request +You can find Enhancement asked by community at [Enhancement issue] ## Pull requests @@ -153,8 +153,7 @@ these guidelines is the best way to get your work included in MySQLTuner. git checkout -b ``` -4. Commit your changes in logical chunks. Please adhere to these [git commit - message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines] or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) 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. git push origin ``` -7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description. +7. [Open a Pull Request] with a clear title and description. **IMPORTANT**: By submitting a patch, you agree to allow the project owner to -license your work under the [GPLv3 License](https://en.wikipedia.org/wiki/GNU_General_Public_License). +license your work under the [GPLv3 License]. -Copy of the license is available at [LICENSE](https://github.com/major/MySQLTuner-perl/blob/master/LICENSE) +Copy of the license is available at [LICENSE] -#### MySQLTuner Code Conventions +## MySQLTuner Code Conventions 1. Check code convention using **perltidy** and **perlcritic** 2. Don't manually update the version number in `mysqltuner.pl`. - + +[Enhancement issue]:https://github.com/major/MySQLTuner-perl/labels/enhancement +[GitHub issue search]:https://github.com/major/MySQLTuner-perl/search?type=Issues +[git commit message guidelines]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[Open a Pull Request]:https://help.github.com/articles/using-pull-requests/ +[GPLv3 License]:https://en.wikipedia.org/wiki/GNU_General_Public_License +[LICENSE]:https://github.com/major/MySQLTuner-perl/blob/master/LICENSE