|
| 1 | +--- |
| 2 | +title: Contributing to `MGIS` |
| 3 | +author: Thomas Helfer |
| 4 | +date: 2020 |
| 5 | +lang: en-EN |
| 6 | +numbersections: true |
| 7 | +documentclass: article |
| 8 | +from: markdown+tex_math_single_backslash |
| 9 | +link-citations: true |
| 10 | +colorlinks: true |
| 11 | +figPrefixTemplate: "$$i$$" |
| 12 | +tabPrefixTemplate: "$$i$$" |
| 13 | +secPrefixTemplate: "$$i$$" |
| 14 | +eqnPrefixTemplate: "($$i$$)" |
| 15 | +--- |
| 16 | + |
| 17 | +Contributions to `MGIS` are greatly appreciated. |
| 18 | + |
| 19 | +Please take a moment to review this document in order to make the |
| 20 | +contribution process easy and effective for everyone involved. |
| 21 | + |
| 22 | +Following these guidelines helps to communicate that you respect the time of |
| 23 | +the developers managing and developing this open source project. In return, |
| 24 | +they should reciprocate that respect in addressing your issue or assessing |
| 25 | +patches and features. |
| 26 | + |
| 27 | +# Using the issue tracker |
| 28 | + |
| 29 | +The [issue |
| 30 | +tracker](https://github.com/thelfer/MFrontGenericInterfaceSupport/issues) |
| 31 | +is the preferred channel for [bug reports](#bugs), [features |
| 32 | +requests](#features) and [submitting pull requests](#pull-requests), but |
| 33 | +please respect the following restrictions: |
| 34 | + |
| 35 | +* Please **do not** use the issue tracker for personal support requests |
| 36 | + (contact directly the authors |
| 37 | + |
| 38 | + |
| 39 | +# Bug reports |
| 40 | + |
| 41 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 42 | +Good bug reports are extremely helpful - thank you! |
| 43 | + |
| 44 | +Guidelines for bug reports: |
| 45 | + |
| 46 | +1. **Use the GitHub issue search**: check if the issue has already been |
| 47 | + reported. |
| 48 | + |
| 49 | +2. **Check if the issue has been fixed**: try to reproduce it using the |
| 50 | + latest `master` or development branch in the repository. |
| 51 | + |
| 52 | +3. **Isolate the problem**: ideally create a [reduced test |
| 53 | + case]. |
| 54 | + |
| 55 | +A good bug report shouldn't leave others needing to chase you up for more |
| 56 | +information. Please try to be as detailed as possible in your report. What is |
| 57 | +your environment? What steps will reproduce the issue? What compiler(s) and OS |
| 58 | +experience the problem? What would you expect to be the outcome? All these |
| 59 | +details will help people to fix any potential bugs. |
| 60 | + |
| 61 | +Example: |
| 62 | + |
| 63 | +> Short and descriptive example bug report title |
| 64 | +> |
| 65 | +> A summary of the issue, versions of `TFEL/MFront` used and the |
| 66 | +> OS/compiler environment in which it occurs. If suitable, include the |
| 67 | +> steps required to reproduce the bug. |
| 68 | +> |
| 69 | +> 1. This is the first step |
| 70 | +> 2. This is the second step |
| 71 | +> 3. Further steps, etc. |
| 72 | +> |
| 73 | +> Any other information you want to share that is relevant to the issue being |
| 74 | +> reported. This might include the lines of code that you have identified as |
| 75 | +> causing the bug, and potential solutions (and your opinions on their |
| 76 | +> merits). |
| 77 | +
|
| 78 | +# Feature requests |
| 79 | + |
| 80 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 81 | +fits with the scope and aims of the project. It's up to *you* to make a strong |
| 82 | +case to convince the project's developers of the merits of this feature. Please |
| 83 | +provide as much detail and context as possible. |
| 84 | + |
| 85 | +# Pull requests |
| 86 | + |
| 87 | +Good pull requests - patches, improvements, new features - are a fantastic |
| 88 | +help. They should remain focused in scope and avoid containing unrelated |
| 89 | +commits. |
| 90 | + |
| 91 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 92 | +implementing features, refactoring code, porting to a different language), |
| 93 | +otherwise you risk spending a lot of time working on something that the |
| 94 | +project's developers might not want to merge into the project. |
| 95 | + |
| 96 | +Please adhere to the coding conventions used throughout a project (indentation, |
| 97 | +accurate comments, etc.) and any other requirements (such as test coverage). |
| 98 | + |
| 99 | +Adhering to the following this 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>/MFrontGenericInterfaceSupport.git |
| 108 | + # Navigate to the newly cloned directory |
| 109 | + cd MFrontGenericInterfaceSupport |
| 110 | + # Assign the original repo to a remote called "upstream" |
| 111 | + git remote add upstream https://github.com/thelfer/MFrontGenericInterfaceSupport.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. |
| 133 | + |
| 134 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 135 | + |
| 136 | + ```bash |
| 137 | + git pull [--rebase] upstream master |
| 138 | + ``` |
| 139 | + |
| 140 | +6. Push your topic branch up to your fork: |
| 141 | + |
| 142 | + ```bash |
| 143 | + git push origin <topic-branch-name> |
| 144 | + ``` |
| 145 | + |
| 146 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 147 | + with a clear title and description. |
| 148 | + |
| 149 | +**IMPORTANT**: By submitting a patch, you agree to allow the project owners to |
| 150 | +license your work under the the terms of the *LGPL License*. |
| 151 | + |
| 152 | +<!-- |
| 153 | +This file is merely a copy of the `CONTRIBUTING.md` file of the |
| 154 | +html5boilerplate project |
| 155 | +
|
| 156 | +Copyright (c) HTML5 Boilerplate |
| 157 | +
|
| 158 | +Permission is hereby granted, free of charge, to any person obtaining a copy of |
| 159 | +this software and associated documentation files (the "Software"), to deal in |
| 160 | +the Software without restriction, including without limitation the rights to |
| 161 | +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies |
| 162 | +of the Software, and to permit persons to whom the Software is furnished to do |
| 163 | +so, subject to the following conditions: |
| 164 | +
|
| 165 | +The above copyright notice and this permission notice shall be included in all |
| 166 | +copies or substantial portions of the Software. |
| 167 | +
|
| 168 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 169 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 170 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 171 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 172 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 173 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 174 | +SOFTWARE. |
| 175 | +--> |
0 commit comments