|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Looking to contribute something? **Here's how you can help.** |
| 4 | + |
| 5 | +Please take a moment to review this document in order to make the contribution |
| 6 | +process easy and effective for everyone involved. |
| 7 | + |
| 8 | +Following these guidelines helps to communicate that you respect the time of |
| 9 | +the developers managing and developing this open source project. In return, |
| 10 | +they should reciprocate that respect in addressing your issue or assessing |
| 11 | +patches and features. |
| 12 | + |
| 13 | + |
| 14 | +## Using the issue tracker |
| 15 | + |
| 16 | +The issue tracker is the preferred channel for [bug reports](#bug-reports), |
| 17 | +[features requests](#feature-requests) and |
| 18 | +[submitting pull requests](#pull-requests), but please respect the |
| 19 | +following restrictions: |
| 20 | + |
| 21 | +* Please **do not** use the issue tracker for personal support requests. Stack |
| 22 | + Overflow is a better place to get help. |
| 23 | + |
| 24 | +* Please **do not** derail or troll issues. Keep the discussion on topic and |
| 25 | + respect the opinions of others. |
| 26 | + |
| 27 | +* Please **do not** open issues or pull requests which *belongs to* third party |
| 28 | + components. |
| 29 | + |
| 30 | + |
| 31 | +## Bug reports |
| 32 | + |
| 33 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 34 | +Good bug reports are extremely helpful, so thanks! |
| 35 | + |
| 36 | +Guidelines for bug reports: |
| 37 | + |
| 38 | +1. **Use the GitHub issue search** — check if the issue has already been |
| 39 | + reported. |
| 40 | + |
| 41 | +2. **Check if the issue has been fixed** — try to reproduce it using the |
| 42 | + latest `master` or development branch in the repository. |
| 43 | + |
| 44 | +3. **Isolate the problem** — ideally create an |
| 45 | + [SSCCE](http://www.sscce.org/) and a live example. |
| 46 | + Uploading the project on cloud storage (OneDrive, DropBox, et el.) |
| 47 | + or creating a sample GitHub repository is also helpful. |
| 48 | + |
| 49 | + |
| 50 | +A good bug report shouldn't leave others needing to chase you up for more |
| 51 | +information. Please try to be as detailed as possible in your report. What is |
| 52 | +your environment? What steps will reproduce the issue? What browser(s) and OS |
| 53 | +experience the problem? Do other browsers show the bug differently? What |
| 54 | +would you expect to be the outcome? All these details will help people to fix |
| 55 | +any potential bugs. |
| 56 | + |
| 57 | +Example: |
| 58 | + |
| 59 | +> Short and descriptive example bug report title |
| 60 | +> |
| 61 | +> A summary of the issue and the Visual Studio, browser, OS environments |
| 62 | +> in which it occurs. If suitable, include the steps required to reproduce the bug. |
| 63 | +> |
| 64 | +> 1. This is the first step |
| 65 | +> 2. This is the second step |
| 66 | +> 3. Further steps, etc. |
| 67 | +> |
| 68 | +> `<url>` - a link to the project/file uploaded on cloud storage or other publicly accessible medium. |
| 69 | +> |
| 70 | +> Any other information you want to share that is relevant to the issue being |
| 71 | +> reported. This might include the lines of code that you have identified as |
| 72 | +> causing the bug, and potential solutions (and your opinions on their |
| 73 | +> merits). |
| 74 | +
|
| 75 | + |
| 76 | +## Feature requests |
| 77 | + |
| 78 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 79 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 80 | +case to convince the project's developers of the merits of this feature. Please |
| 81 | +provide as much detail and context as possible. |
| 82 | + |
| 83 | + |
| 84 | +## Pull requests |
| 85 | + |
| 86 | +Good pull requests, patches, improvements and new features are a fantastic |
| 87 | +help. They should remain focused in scope and avoid containing unrelated |
| 88 | +commits. |
| 89 | + |
| 90 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 91 | +implementing features, refactoring code, porting to a different language), |
| 92 | +otherwise you risk spending a lot of time working on something that the |
| 93 | +project's developers might not want to merge into the project. |
| 94 | + |
| 95 | +Please adhere to the [coding guidelines](#code-guidelines) used throughout the |
| 96 | +project (indentation, accurate comments, etc.) and any other requirements |
| 97 | +(such as test coverage). |
| 98 | + |
| 99 | +Adhering to the following process is the best way to get your work |
| 100 | +included in the project: |
| 101 | + |
| 102 | +1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
| 103 | + and configure the remotes: |
| 104 | + |
| 105 | + ```bash |
| 106 | + # Clone your fork of the repo into the current directory |
| 107 | + git clone https://github.com/<your-username>/<this-repro-name>.git |
| 108 | + # Navigate to the newly cloned directory |
| 109 | + cd <folder-name> |
| 110 | + # Assign the original repo to a remote called "upstream" |
| 111 | + git remote add upstream https://github.com/madskristensen/<this-repro-name>.git |
| 112 | + ``` |
| 113 | + |
| 114 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 115 | + |
| 116 | + ```bash |
| 117 | + git checkout master |
| 118 | + git pull upstream master |
| 119 | + ``` |
| 120 | + |
| 121 | +3. Create a new topic branch (off the main project development branch) to |
| 122 | + contain your feature, change, or fix: |
| 123 | + |
| 124 | + ```bash |
| 125 | + git checkout -b <topic-branch-name> |
| 126 | + ``` |
| 127 | + |
| 128 | +4. Commit your changes in logical chunks. Please adhere to these [git commit |
| 129 | + message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 130 | + or your code is unlikely be merged into the main project. Use Git's |
| 131 | + [interactive rebase](https://help.github.com/articles/interactive-rebase) |
| 132 | + feature to tidy up your commits before making them public. Also, prepend name of the feature |
| 133 | + to the commit message. For instance: "SCSS: Fixes compiler results for IFileListener.\nFixes `#123`" |
| 134 | + |
| 135 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 136 | + |
| 137 | + ```bash |
| 138 | + git pull [--rebase] upstream master |
| 139 | + ``` |
| 140 | + |
| 141 | +6. Push your topic branch up to your fork: |
| 142 | + |
| 143 | + ```bash |
| 144 | + git push origin <topic-branch-name> |
| 145 | + ``` |
| 146 | + |
| 147 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 148 | + with a clear title and description against the `master` branch. |
| 149 | + |
| 150 | + |
| 151 | +## Code guidelines |
| 152 | + |
| 153 | +- Always use proper indentation. |
| 154 | +- In Visual Studio under `Tools > Options > Text Editor > C# > Advanced`, make sure |
| 155 | + `Place 'System' directives first when sorting usings` option is enabled (checked). |
| 156 | +- Before committing, organize usings for each updated C# source file. Either you can |
| 157 | + right-click editor and select `Organize Usings > Remove and sort` OR use extension |
| 158 | + like [BatchFormat](http://visualstudiogallery.msdn.microsoft.com/a7f75c34-82b4-4357-9c66-c18e32b9393e). |
| 159 | +- Before committing, run Code Analysis in `Debug` configuration and follow the guidelines |
| 160 | + to fix CA issues. Code Analysis commits can be made separately. |
0 commit comments