|
| 1 | +# Contributing to the SQL Server Kit |
| 2 | +Please take a moment to review this document in order to make the contribution |
| 3 | +process easy and effective for everyone involved. |
| 4 | + |
| 5 | +Following these guidelines will help us get back to you more quickly, and will |
| 6 | +show that you care about making MySQLTuner better just like we do. In return, we'll |
| 7 | +do our best to respond to your issue or pull request as soon as possible with |
| 8 | +the same respect. |
| 9 | + |
| 10 | +_**Please Note:** These guidelines are adapted from [@necolas](https://github.com/necolas)'s |
| 11 | +[issue-guidelines](https://github.com/necolas/issue-guidelines) and serve as |
| 12 | +an excellent starting point for contributing to any open source project._ |
| 13 | + |
| 14 | + |
| 15 | +## Feature requests |
| 16 | +<a name="features"></a> |
| 17 | + |
| 18 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 19 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 20 | +case to convince the project's developers of the merits of this feature. Please |
| 21 | +provide as much detail and context as possible. |
| 22 | + |
| 23 | +Building something great means choosing features carefully especially because it |
| 24 | +is much, much easier to add features than it is to take them away. Additions |
| 25 | + will be evaluated on a combination of scope (how well it fits into the |
| 26 | +project), maintenance burden and general usefulness. |
| 27 | + |
| 28 | +Creating something great often means saying no to seemingly good ideas. Don't |
| 29 | +despair if your feature request isn't accepted, take action! Fork the |
| 30 | +repository, build your idea and share it with others. We released this project under |
| 31 | +the [LICENSE] for this purpose precisely. Open source works best when smart |
| 32 | +and dedicated people riff off of each others' ideas to make even greater things. |
| 33 | + |
| 34 | + |
| 35 | +## Pull requests |
| 36 | +<a name="pull-requests"></a> |
| 37 | + |
| 38 | +Good pull requests — patches, improvements, new features — are a fantastic help. |
| 39 | +They should remain focused in scope and avoid containing unrelated commits. |
| 40 | + |
| 41 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 42 | +implementing features, refactoring code, porting to a different language), |
| 43 | +otherwise you risk spending a lot of time working on something that the |
| 44 | +project's developers might not want to merge into the project. You can solicit |
| 45 | +feedback and opinions in an open feature request thread or create a new one. |
| 46 | + |
| 47 | +Please use the [git flow for pull requests](#git-flow) and follow SQL Server KIT |
| 48 | +[code conventions](#code-conventions) before submitting your work. |
| 49 | + |
| 50 | + |
| 51 | +## Git Flow for pull requests |
| 52 | +<a name="git-flow"></a> |
| 53 | + |
| 54 | +1. [Fork] the project, clone your fork, and configure the remotes: |
| 55 | + |
| 56 | + ```bash |
| 57 | + # Clone your fork of the repo into the current directory |
| 58 | + git clone [email protected]: <YOUR_USERNAME >/sqlserver-kit.git |
| 59 | + # Navigate to the newly cloned directory |
| 60 | + cd sqlserver-kit |
| 61 | + # Assign the original repo to a remote called "upstream" |
| 62 | + git remote add upstream https://github.com/ktaranov/sqlserver-kit |
| 63 | + ``` |
| 64 | + |
| 65 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 66 | + |
| 67 | + ```bash |
| 68 | + git checkout master |
| 69 | + git pull upstream master |
| 70 | + ``` |
| 71 | + |
| 72 | +3. Create a new topic branch (off the main project development branch) to |
| 73 | + contain your feature, change, or fix: |
| 74 | + |
| 75 | + ```bash |
| 76 | + git checkout -b <topic-branch-name> |
| 77 | + ``` |
| 78 | + |
| 79 | +4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines] |
| 80 | + or your code is unlikely be merged into the main project. Use Git's [interactive rebase] |
| 81 | + feature to tidy up your commits before making them public. |
| 82 | + |
| 83 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 84 | + |
| 85 | + ```bash |
| 86 | + git pull [--rebase] upstream master |
| 87 | + ``` |
| 88 | + |
| 89 | +6. Push your topic branch up to your fork: |
| 90 | + |
| 91 | + ```bash |
| 92 | + git push origin <topic-branch-name> |
| 93 | + ``` |
| 94 | + |
| 95 | +7. [Open a Pull Request] with a clear title and description. |
| 96 | + |
| 97 | +**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the MIT [LICENSE] |
| 98 | + |
| 99 | + |
| 100 | +## SQL Server KIT Code Conventions |
| 101 | +<a name="code-conventions"></a> |
| 102 | + |
| 103 | +Check [code convention] |
| 104 | + |
| 105 | + |
| 106 | +[Fork]:https://help.github.com/articles/fork-a-repo/ |
| 107 | +[git commit message guidelines]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
| 108 | +[interactive rebase]:https://help.github.com/articles/about-git-rebase/ |
| 109 | +[Open a Pull Request]:https://help.github.com/articles/about-pull-requests/ |
| 110 | +[LICENSE]:https://github.com/ktaranov/sqlserver-kit/blob/master/LICENSE.md |
| 111 | +[code convention]:https://github.com/ktaranov/sqlserver-kit/blob/master/SQL%20Server%20Name%20Convention%20and%20T-SQL%20Programming%20Style.md |
0 commit comments