├── .github └── ISSUE_TEMPLATE │ └── review-proposal.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── floobits.gif ├── guidelines_for_reviewers.md ├── remote.md ├── tmate-client-side.gif └── tmate-server-side.gif /.github/ISSUE_TEMPLATE/review-proposal.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: review proposal 3 | about: An issue template to propose code review 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Brief project description 11 | Briefly describe the context around your code: research topic, what is your code for, for how long you have been developing it. 12 | 13 | ## The code 14 | **Language**: 15 | **Type**: 16 | - [ ] Script or collection of scripts 17 | - [ ] Library 18 | - [ ] Standalone software 19 | - [ ] I have no idea 20 | 21 | **Further details**: 22 | 23 | ## Code review format 24 | I'd rather 25 | - [ ] Meet in person 26 | - [ ] Meet remotely 27 | - [ ] Other format: 28 | - [ ] No preference 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to this repository 2 | 3 | The Oxford Code Review Network is a community-owned initiative. 4 | As such, this repository is a living document, open to contributions. 5 | 6 | If you think something is wrong, or if you would like to add something somewhere, just [fork](https://guides.github.com/activities/forking/) this repository and [make a Pull Request](https://guides.github.com/activities/forking/#making-a-pull-request). 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution-ShareAlike 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution-ShareAlike 4.0 International Public 58 | License 59 | 60 | By exercising the Licensed Rights (defined below), You accept and agree 61 | to be bound by the terms and conditions of this Creative Commons 62 | Attribution-ShareAlike 4.0 International Public License ("Public 63 | License"). To the extent this Public License may be interpreted as a 64 | contract, You are granted the Licensed Rights in consideration of Your 65 | acceptance of these terms and conditions, and the Licensor grants You 66 | such rights in consideration of benefits the Licensor receives from 67 | making the Licensed Material available under these terms and 68 | conditions. 69 | 70 | 71 | Section 1 -- Definitions. 72 | 73 | a. Adapted Material means material subject to Copyright and Similar 74 | Rights that is derived from or based upon the Licensed Material 75 | and in which the Licensed Material is translated, altered, 76 | arranged, transformed, or otherwise modified in a manner requiring 77 | permission under the Copyright and Similar Rights held by the 78 | Licensor. For purposes of this Public License, where the Licensed 79 | Material is a musical work, performance, or sound recording, 80 | Adapted Material is always produced where the Licensed Material is 81 | synched in timed relation with a moving image. 82 | 83 | b. Adapter's License means the license You apply to Your Copyright 84 | and Similar Rights in Your contributions to Adapted Material in 85 | accordance with the terms and conditions of this Public License. 86 | 87 | c. BY-SA Compatible License means a license listed at 88 | creativecommons.org/compatiblelicenses, approved by Creative 89 | Commons as essentially the equivalent of this Public License. 90 | 91 | d. Copyright and Similar Rights means copyright and/or similar rights 92 | closely related to copyright including, without limitation, 93 | performance, broadcast, sound recording, and Sui Generis Database 94 | Rights, without regard to how the rights are labeled or 95 | categorized. For purposes of this Public License, the rights 96 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 97 | Rights. 98 | 99 | e. Effective Technological Measures means those measures that, in the 100 | absence of proper authority, may not be circumvented under laws 101 | fulfilling obligations under Article 11 of the WIPO Copyright 102 | Treaty adopted on December 20, 1996, and/or similar international 103 | agreements. 104 | 105 | f. Exceptions and Limitations means fair use, fair dealing, and/or 106 | any other exception or limitation to Copyright and Similar Rights 107 | that applies to Your use of the Licensed Material. 108 | 109 | g. License Elements means the license attributes listed in the name 110 | of a Creative Commons Public License. The License Elements of this 111 | Public License are Attribution and ShareAlike. 112 | 113 | h. Licensed Material means the artistic or literary work, database, 114 | or other material to which the Licensor applied this Public 115 | License. 116 | 117 | i. Licensed Rights means the rights granted to You subject to the 118 | terms and conditions of this Public License, which are limited to 119 | all Copyright and Similar Rights that apply to Your use of the 120 | Licensed Material and that the Licensor has authority to license. 121 | 122 | j. Licensor means the individual(s) or entity(ies) granting rights 123 | under this Public License. 124 | 125 | k. Share means to provide material to the public by any means or 126 | process that requires permission under the Licensed Rights, such 127 | as reproduction, public display, public performance, distribution, 128 | dissemination, communication, or importation, and to make material 129 | available to the public including in ways that members of the 130 | public may access the material from a place and at a time 131 | individually chosen by them. 132 | 133 | l. Sui Generis Database Rights means rights other than copyright 134 | resulting from Directive 96/9/EC of the European Parliament and of 135 | the Council of 11 March 1996 on the legal protection of databases, 136 | as amended and/or succeeded, as well as other essentially 137 | equivalent rights anywhere in the world. 138 | 139 | m. You means the individual or entity exercising the Licensed Rights 140 | under this Public License. Your has a corresponding meaning. 141 | 142 | 143 | Section 2 -- Scope. 144 | 145 | a. License grant. 146 | 147 | 1. Subject to the terms and conditions of this Public License, 148 | the Licensor hereby grants You a worldwide, royalty-free, 149 | non-sublicensable, non-exclusive, irrevocable license to 150 | exercise the Licensed Rights in the Licensed Material to: 151 | 152 | a. reproduce and Share the Licensed Material, in whole or 153 | in part; and 154 | 155 | b. produce, reproduce, and Share Adapted Material. 156 | 157 | 2. Exceptions and Limitations. For the avoidance of doubt, where 158 | Exceptions and Limitations apply to Your use, this Public 159 | License does not apply, and You do not need to comply with 160 | its terms and conditions. 161 | 162 | 3. Term. The term of this Public License is specified in Section 163 | 6(a). 164 | 165 | 4. Media and formats; technical modifications allowed. The 166 | Licensor authorizes You to exercise the Licensed Rights in 167 | all media and formats whether now known or hereafter created, 168 | and to make technical modifications necessary to do so. The 169 | Licensor waives and/or agrees not to assert any right or 170 | authority to forbid You from making technical modifications 171 | necessary to exercise the Licensed Rights, including 172 | technical modifications necessary to circumvent Effective 173 | Technological Measures. For purposes of this Public License, 174 | simply making modifications authorized by this Section 2(a) 175 | (4) never produces Adapted Material. 176 | 177 | 5. Downstream recipients. 178 | 179 | a. Offer from the Licensor -- Licensed Material. Every 180 | recipient of the Licensed Material automatically 181 | receives an offer from the Licensor to exercise the 182 | Licensed Rights under the terms and conditions of this 183 | Public License. 184 | 185 | b. Additional offer from the Licensor -- Adapted Material. 186 | Every recipient of Adapted Material from You 187 | automatically receives an offer from the Licensor to 188 | exercise the Licensed Rights in the Adapted Material 189 | under the conditions of the Adapter's License You apply. 190 | 191 | c. No downstream restrictions. You may not offer or impose 192 | any additional or different terms or conditions on, or 193 | apply any Effective Technological Measures to, the 194 | Licensed Material if doing so restricts exercise of the 195 | Licensed Rights by any recipient of the Licensed 196 | Material. 197 | 198 | 6. No endorsement. Nothing in this Public License constitutes or 199 | may be construed as permission to assert or imply that You 200 | are, or that Your use of the Licensed Material is, connected 201 | with, or sponsored, endorsed, or granted official status by, 202 | the Licensor or others designated to receive attribution as 203 | provided in Section 3(a)(1)(A)(i). 204 | 205 | b. Other rights. 206 | 207 | 1. Moral rights, such as the right of integrity, are not 208 | licensed under this Public License, nor are publicity, 209 | privacy, and/or other similar personality rights; however, to 210 | the extent possible, the Licensor waives and/or agrees not to 211 | assert any such rights held by the Licensor to the limited 212 | extent necessary to allow You to exercise the Licensed 213 | Rights, but not otherwise. 214 | 215 | 2. Patent and trademark rights are not licensed under this 216 | Public License. 217 | 218 | 3. To the extent possible, the Licensor waives any right to 219 | collect royalties from You for the exercise of the Licensed 220 | Rights, whether directly or through a collecting society 221 | under any voluntary or waivable statutory or compulsory 222 | licensing scheme. In all other cases the Licensor expressly 223 | reserves any right to collect such royalties. 224 | 225 | 226 | Section 3 -- License Conditions. 227 | 228 | Your exercise of the Licensed Rights is expressly made subject to the 229 | following conditions. 230 | 231 | a. Attribution. 232 | 233 | 1. If You Share the Licensed Material (including in modified 234 | form), You must: 235 | 236 | a. retain the following if it is supplied by the Licensor 237 | with the Licensed Material: 238 | 239 | i. identification of the creator(s) of the Licensed 240 | Material and any others designated to receive 241 | attribution, in any reasonable manner requested by 242 | the Licensor (including by pseudonym if 243 | designated); 244 | 245 | ii. a copyright notice; 246 | 247 | iii. a notice that refers to this Public License; 248 | 249 | iv. a notice that refers to the disclaimer of 250 | warranties; 251 | 252 | v. a URI or hyperlink to the Licensed Material to the 253 | extent reasonably practicable; 254 | 255 | b. indicate if You modified the Licensed Material and 256 | retain an indication of any previous modifications; and 257 | 258 | c. indicate the Licensed Material is licensed under this 259 | Public License, and include the text of, or the URI or 260 | hyperlink to, this Public License. 261 | 262 | 2. You may satisfy the conditions in Section 3(a)(1) in any 263 | reasonable manner based on the medium, means, and context in 264 | which You Share the Licensed Material. For example, it may be 265 | reasonable to satisfy the conditions by providing a URI or 266 | hyperlink to a resource that includes the required 267 | information. 268 | 269 | 3. If requested by the Licensor, You must remove any of the 270 | information required by Section 3(a)(1)(A) to the extent 271 | reasonably practicable. 272 | 273 | b. ShareAlike. 274 | 275 | In addition to the conditions in Section 3(a), if You Share 276 | Adapted Material You produce, the following conditions also apply. 277 | 278 | 1. The Adapter's License You apply must be a Creative Commons 279 | license with the same License Elements, this version or 280 | later, or a BY-SA Compatible License. 281 | 282 | 2. You must include the text of, or the URI or hyperlink to, the 283 | Adapter's License You apply. You may satisfy this condition 284 | in any reasonable manner based on the medium, means, and 285 | context in which You Share Adapted Material. 286 | 287 | 3. You may not offer or impose any additional or different terms 288 | or conditions on, or apply any Effective Technological 289 | Measures to, Adapted Material that restrict exercise of the 290 | rights granted under the Adapter's License You apply. 291 | 292 | 293 | Section 4 -- Sui Generis Database Rights. 294 | 295 | Where the Licensed Rights include Sui Generis Database Rights that 296 | apply to Your use of the Licensed Material: 297 | 298 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 299 | to extract, reuse, reproduce, and Share all or a substantial 300 | portion of the contents of the database; 301 | 302 | b. if You include all or a substantial portion of the database 303 | contents in a database in which You have Sui Generis Database 304 | Rights, then the database in which You have Sui Generis Database 305 | Rights (but not its individual contents) is Adapted Material, 306 | 307 | including for purposes of Section 3(b); and 308 | c. You must comply with the conditions in Section 3(a) if You Share 309 | all or a substantial portion of the contents of the database. 310 | 311 | For the avoidance of doubt, this Section 4 supplements and does not 312 | replace Your obligations under this Public License where the Licensed 313 | Rights include other Copyright and Similar Rights. 314 | 315 | 316 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 317 | 318 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 319 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 320 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 321 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 322 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 323 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 324 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 325 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 326 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 327 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 328 | 329 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 330 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 331 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 332 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 333 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 334 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 335 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 336 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 337 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 338 | 339 | c. The disclaimer of warranties and limitation of liability provided 340 | above shall be interpreted in a manner that, to the extent 341 | possible, most closely approximates an absolute disclaimer and 342 | waiver of all liability. 343 | 344 | 345 | Section 6 -- Term and Termination. 346 | 347 | a. This Public License applies for the term of the Copyright and 348 | Similar Rights licensed here. However, if You fail to comply with 349 | this Public License, then Your rights under this Public License 350 | terminate automatically. 351 | 352 | b. Where Your right to use the Licensed Material has terminated under 353 | Section 6(a), it reinstates: 354 | 355 | 1. automatically as of the date the violation is cured, provided 356 | it is cured within 30 days of Your discovery of the 357 | violation; or 358 | 359 | 2. upon express reinstatement by the Licensor. 360 | 361 | For the avoidance of doubt, this Section 6(b) does not affect any 362 | right the Licensor may have to seek remedies for Your violations 363 | of this Public License. 364 | 365 | c. For the avoidance of doubt, the Licensor may also offer the 366 | Licensed Material under separate terms or conditions or stop 367 | distributing the Licensed Material at any time; however, doing so 368 | will not terminate this Public License. 369 | 370 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 371 | License. 372 | 373 | 374 | Section 7 -- Other Terms and Conditions. 375 | 376 | a. The Licensor shall not be bound by any additional or different 377 | terms or conditions communicated by You unless expressly agreed. 378 | 379 | b. Any arrangements, understandings, or agreements regarding the 380 | Licensed Material not stated herein are separate from and 381 | independent of the terms and conditions of this Public License. 382 | 383 | 384 | Section 8 -- Interpretation. 385 | 386 | a. For the avoidance of doubt, this Public License does not, and 387 | shall not be interpreted to, reduce, limit, restrict, or impose 388 | conditions on any use of the Licensed Material that could lawfully 389 | be made without permission under this Public License. 390 | 391 | b. To the extent possible, if any provision of this Public License is 392 | deemed unenforceable, it shall be automatically reformed to the 393 | minimum extent necessary to make it enforceable. If the provision 394 | cannot be reformed, it shall be severed from this Public License 395 | without affecting the enforceability of the remaining terms and 396 | conditions. 397 | 398 | c. No term or condition of this Public License will be waived and no 399 | failure to comply consented to unless expressly agreed to by the 400 | Licensor. 401 | 402 | d. Nothing in this Public License constitutes or may be interpreted 403 | as a limitation upon, or waiver of, any privileges and immunities 404 | that apply to the Licensor or You, including from the legal 405 | processes of any jurisdiction or authority. 406 | 407 | 408 | ======================================================================= 409 | 410 | Creative Commons is not a party to its public 411 | licenses. Notwithstanding, Creative Commons may elect to apply one of 412 | its public licenses to material it publishes and in those instances 413 | will be considered the “Licensor.” The text of the Creative Commons 414 | public licenses is dedicated to the public domain under the CC0 Public 415 | Domain Dedication. Except for the limited purpose of indicating that 416 | material is shared under a Creative Commons public license or as 417 | otherwise permitted by the Creative Commons policies published at 418 | creativecommons.org/policies, Creative Commons does not authorize the 419 | use of the trademark "Creative Commons" or any other trademark or logo 420 | of Creative Commons without its prior written consent including, 421 | without limitation, in connection with any unauthorized modifications 422 | to any of its public licenses or any other arrangements, 423 | understandings, or agreements concerning use of licensed material. For 424 | the avoidance of doubt, this paragraph does not form part of the 425 | public licenses. 426 | 427 | Creative Commons may be contacted at creativecommons.org. 428 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # :mag: Oxford code review network 2 | 3 | [Code review guidelines](#guidelines) | [Getting started](#gettingstarted) | [Tools for remote code reviews](remote.md) | [Guidelines for reviewers](guidelines_for_reviewers.md) | [Events](#whatshappening) :mega: 4 | 5 | Want to get feedback on your code? Could use a second pair of eyes to track down a bug? 6 | Interested in reviewing other researchers' code? 7 | 8 | This repository acts as a central place for organising **code reviews at the University of Oxford**. 9 | If you'd like your code to be reviewed by someone else, simply open an issue with a brief description of your code. 10 | If you'd like to volunteer to review some research code, just leave a comment on the corresponding issue to let the author know that you're available to review their code. 11 | If you'd like to participate but are not familiar with GitHub or/and its issue tracking system, see the [getting started section](#gettingstarted). 12 | 13 | Code reviews are **short** and **informal** meetings in which a researcher or student (referred to as the *code author*, or *reviewee*) discuss their code with one or several other researchers or students (referred to as *reviewers*). 14 | Code reviews typically last an hour and focus on a very specific part of a project, whether it's a short script or a couple of functions/subroutines. 15 | Particularly, code reviews are not meant as a formal quality control for an entire project, but rather as an excuse for both rewiewees and reviewers to have a conversation over a short piece of code. 16 | It is an opportunity for both to exchange about their respective software practice and learn from one another. 17 | 18 | You can find more information about code reviews by reading the [Code review guidelines](#guidelines) section. 19 | 20 | You can also [watch an introduction to OxCRN (YouTube)](https://www.youtube.com/watch?v=6g1GfTgSVbY&t=1276s). :tv: 21 | 22 | Engaging in regular code reviews, both as reviewer and reviewee, can have a **tremendous impact on the quality of your research software**: it will be more readable, maintainable and extendable, both by yourself and your colleagues. 23 | This means a more efficient, more reproducible and easier to disseminate research. To learn more about the benefit of code reviews for research software, see [Why code reviews?](#whatarecodereviews). 24 | 25 | If you don't feel confident in your ability to review code, you might be surprised! 26 | See the [guidelines for reviewers](guidelines_for_reviewers.md). 27 | 28 | The Oxford Code Review Network is supported by the [Oxford Research Software Engineering group](https://www.rse.ox.ac.uk/) and [Reproducible Research Oxford](https://ox.ukrn.org/). 29 | Everyone is welcome to contribute to this repository, see [the contributing guidelines](CONTRIBUTING.md). 30 | 31 | ## Community 32 | 33 | OxCRN aims at building an active and welcoming community through regular events. Please [subscribe to the OxCRN mailing list](#whatshappening) to receive updates. :incoming_envelope: 34 | 35 | You can also [Join the OxCRN Slack workspace](https://join.slack.com/t/oxfordcodereviewnet/shared_invite/zt-fnitmq4n-_hVZyaFdFfC0lbLb47gtww). _If your mail domain is not in the list of authorized domains, feel free to request an invitation._ 36 | _If you want to get in touch, but don't want to use Slack, feel free to contact one of the main contributors by email (you can find them on the right)._ 37 | 38 | ## Upcoming events 39 | 40 | OxCRN aims at building an active and welcoming community through regular events. 41 | 42 | Please subscribe to `oxcrn-announce@maillist.ox.ac.uk`. Click [here](https://web.maillist.ox.ac.uk/ox/subscribe/oxcrn-announce) to do so. 43 | 44 | ### OxCRN remote launch event - 17.07.2020 14:00-15:00 45 | 46 | - Introduction to OxCRN 47 | - Goals and roadmap 48 | - code review demo :microscope: 49 | - How to get involved 50 | - Open discussion :tea: :coffee: 51 | 52 | [Watch the presentation on YouTube](https://www.youtube.com/watch?v=6g1GfTgSVbY&t=1276s). 53 | 54 | ## Code review guidelines 55 | 56 | **All code reviews are executed remotely until further notice.** 57 | **See [remote code reviews](remote.md) for advice about carrying out remote code reviews.** 58 | 59 | ### Typical code review scenario 60 | 61 | *Both Priya and Sam are fictitious individuals. Any resemblance to real and actual names is purely coincidental.* 62 | 63 | Priya is a researcher in the Physics Department, and she's currently writing a small python library to process her experimental data. 64 | She would like to get in touch with other python programmers in Oxford to have someone else look at her code, potentially highlighting unexpected issues and providing some feedback on her coding style. 65 | Priya selects a small portion of her library (about 300 lines) that she thinks is representative. 66 | She opens [an issue](https://github.com/OxfordCodeReviewNet/forum/issues/3#issue-636951537) on this repository. 67 | 68 | Sam is a post-doc in the Department of Zoology. They primarily use R for their data analysis, but they have been learning python recently. 69 | They find Priya's issue on this repo, and decide it's a good opportunity to have a close look a some real life python... as well as helping out a colleague! 70 | Sam leaves [a comment](https://github.com/OxfordCodeReviewNet/forum/issues/3#issuecomment-642595092) on Priya's issue, and they both decide to meet on MS Teams next week. 71 | 72 | Priya has a look at the [guidelines for remote code reviews](remote.md) and decides to use [tmate](https://tmate.io/) to live share her Vim session with Sam. 73 | Both meet on MS Teams as planned, and Priya briefly describes the context of her research to Sam (who's trying their best to recall their A-level physics). 74 | Priya walks Sam through the code snippet she selected, explaining her design choices, highlighting the parts that she's proud of, and the parts that she thinks could be improved. 75 | Sam asks Priya as many questions as they want until they feel they have a good understanding of the code. 76 | 77 | Sam has read the [guidelines for reviewers](guidelines_for_reviewers.md), and notices a few things: 78 | 79 | - One of Priya's function takes a duration as an argument. Sam flags that the function would break if a user passed a negative number. Priya should perhaps make sure that a proper `ValueError` exception is raised if a user calls the function with a negative duration. 80 | - Next, Sam notices that Priya's code is split into four very long functions. They advise Priya to break these down into smaller functions with descriptive names. This will make her code easier to read, reduce the amount of code that's duplicated, and facilitate future extension of her data analysis pipeline. 81 | - Sam recently read about python's list comprehension syntax, and shares the tip with Priya, who's using a lot of `append()` to build lists. 82 | 83 | At the same time, Sam notices that Priya is using something called a "python virtual environment" to develop her library, and they wonder what that is. Priya showcases [python venvs](https://realpython.com/python-virtual-environments-a-primer/) to Sam and explain why they're best practice for python developers. 84 | 85 | ### Format of code reviews 86 | 87 | ~~Ideally, the code review is carried out face to face, the developer and reviewer sitting together.~~ 88 | 89 | If not possible, you can [do code reviews remotely](remote.md). 90 | 91 | Typically, a code review starts with the author of the code walking the reviewer trough the code, explaining the details of the implementation. 92 | The reviewer(s) ask as many questions as they want until they feel they have a good understanding of the code. 93 | Questions, comments and suggestions will naturally arise. 94 | 95 | ### Location 96 | 97 | ~~The location of the code review (or the tool used for the remote meeting) is left to the author and reviewer to decide upon (your lab/department, a library, a local café, University Parks...).~~ 98 | 99 | All code reviews must be carried out remotely at the moment. Please have a look at the [list of options for remote code reviews](remote.md). 100 | 101 | ### Duration and scope of the review 102 | 103 | - If you're submitting some code to review, it is best practice to keep it **below 400 lines**. 104 | If the submitted piece of code is part of a larger project, it should ideally be representative of your general coding practices on that project. 105 | 106 | - Code reviewing can be a tiring exercise! We recommend to keep the sessions short (one hour maximum), but you are welcome to meet more than once. 107 | 108 | ## Why code reviews 109 | 110 | A code review is simply the action of having a deep and critical look at someone else's code. 111 | This is common practice in the private sector, and more generally in the open source software development community, but still very rarely happen in academia. 112 | Typically, the author of the code sits down with one or more colleagues and walks them through their code, explaining design choices and implementation details. 113 | The role of reviewers is to try to identify potential issues, but also highlight and encourage the use of good practices. 114 | 115 | ### Software never comes out perfect 116 | 117 | A common saying in the software world is that the average number of bugs introduced per 1000 lines of code is around 15. 118 | Although such a metric probably isn't reliable, it illustrates the fact that software almost never comes out perfect, and that fixing bugs and issues is part of the software development process. 119 | This is true in industry, and this is true in academia. 120 | 121 | ### A fresh pair of eyes 122 | 123 | By allowing your code to be seen by a fresh pair of eyes, you will find potential flaws that you would not have spotted on your own. 124 | Having someone external to the project is also a great way of fixing bugs or understanding errors, as it forces the author to explain the problem to someone who is unfamiliar with the code. 125 | Furthermore, several people can often come up with different solutions to a given problem, and may have complementary knowledge of the same programming language 126 | 127 | ### A win-win practice 128 | 129 | As a reviewer, you also have a lot to gain from this process, as it is likely that you will come across programming concepts and practices that are completely new to you. 130 | Whether you are a seasoned programmer or a beginner, reviewing code is a great way of developing, sharpening and widening your programming skills. 131 | 132 | ## Getting started 133 | 134 | Make sure you're logged into your GitHub account. If you don't have a GitHub account, you can [create one](https://github.com/join?source=login) for free. 135 | 136 | ### Propose a code review 137 | 138 | 1. If you want to propose a code review, you must first _open an issue_. 139 | At the top of this page, under "**OxfordCodeReviewNet**/**forum**", click on _Issues_. 140 | Here's an illustration from another repository "octo-repo". 141 | ![open issue illustration](https://help.github.com/assets/images/help/repository/repo-tabs-issues.png "Logo Title Text 1") 142 | 2. You can then create a new issue by clicking the green button _New issue_ on the top right of the screen. 143 | The issue comes pre-filled with some place-holder content, feel free to replace it by a description that corresponds to your code. 144 | 145 | > The term _issue_ comes from the word _issue tracker_ (the functionality that you are about to use), used by software developers to report and discuss bugs and problems. However, the issue tracker can be used for anything, such as proposing you code review. 146 | 147 | ### Find code to review 148 | 149 | To see current review opportunities, simply browse the issues by clicking on the _Issues_ tab (see previous section). 150 | If you're interested in reviewing a particular piece of code, simply click on the corresponding issue and write a comment. 151 | 152 | -------------------------------------------------------------------------------- /floobits.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OxfordCodeReviewNet/forum/50543ef35b8be51e9840ac64613555ca7d7af8da/floobits.gif -------------------------------------------------------------------------------- /guidelines_for_reviewers.md: -------------------------------------------------------------------------------- 1 | # Guidelines for reviewers 2 | 3 | Reviewing code can be intimidating, especially if you don't consider yourself as an experienced programmer. 4 | What if you don't find anything to say? 5 | 6 | ## Simply ask questions 7 | 8 | It is a common misconception to think that reviewers must necessarily be advanced developers, and that they must find bugs or make tons of comments for the review to be successful. 9 | 10 | Instead, your main job as a reviewer is **simply to ask questions**. This should be easy, as it is unlikely that you will understand every line of code without explanation. 11 | You first goal as a reviewer is to force the code author to explain their code to you in detail. Doing so, they will very probably identify bugs and area of improvements **themselves**. 12 | 13 | Once you're comfortable reading somebody else's code and asking questions about it, the next step is to look for potential issues yourself. 14 | If you have no idea what to look for, here is a list of the major points to check in a code review. 15 | 16 | ## What to look for as a reviewer 17 | 18 | *Under construction* 19 | 20 | The following points are common guidelines, not rules. Cases may arise where it is best not to follow them. 21 | 22 | 1. [Naming](#naming) 23 | 1. [Duplicated code](#duplicated) 24 | 1. [Long functions](#long) 25 | 1. [Complex if statements](#complexity) 26 | 1. [Obscure lines](#obscure) 27 | 1. [Unintended behaviour](#unintended) 28 | 1. [Comments](#comments) 29 | 1. [Performance low hanging fruits](#performance) 30 | 1. [Potential use of built-in functions](#builtin) 31 | 1. [Potential use of third-party libraries](#third-party) 32 | 33 | ### Code style 34 | 35 | Whatever the programming language, there is usually a style guide, or set of best practices, to follow: 36 | 37 | | Language | Style guide | Tool | 38 | |:----------:|:----------------------------------------:|:-------------------------:| 39 | | Python | PEP8 | pycodestyle | 40 | | C++ | LLVM style guide, Mozilla style guide... | clang-format | 41 | | R | Hadley Wickham's style guide | lintr | 42 | | JavaScript | JavaScript Standard style | JavaScript Standard style | 43 | | Fortran | Fortran Best Practices | gfortran | 44 | | Ruby | Ruby Style Guide | RuboCop | 45 | | Go | Effective Go | gofmt | 46 | | Julia | The Julia Style Guide | ?? | 47 | 48 | Following a style guide makes sure that your code is written in a way that is consistent with code written 49 | by other programmers (assuming they also follow the same style guide). 50 | 51 | - You code will be easier to read and understand for programmers outside your project. 52 | - Code style will be consistent throughout the project even if several developers are working on it. 53 | - Style guides are based on best practices for the language. 54 | 55 | Style guides are well worth the read, but often are lengthy and (sometimes) obscure. Luckily, there are many 56 | software tools to enforce style guides automatically (see table above). 57 | 58 | > It's likely that there are several style guides available for your favourite language. For instance, pretty 59 | > much every web company have their own JavaScript style guide. However, one style guide often 60 | > dominates and is used by most of the community (C++ is a notable exception). This is the one you should probably use! 61 | 62 | 63 | 64 | ### Naming 65 | 66 | Often the hardest part in software development. 67 | 68 | - Always use descriptive names at every level, whether it is for variables, functions/methods or classes. Name of functions, subroutines, and classes should convey intent. 69 | 70 | > Tip: When implementing mathematical expressions, it's often tempting to name the variable after its mathematical symbol (e.g. `alpha`, `m`, `R0`..). 71 | > This is not recommended, as this makes the code less readable, and other people may use different notations. Use explicit names instead 72 | > (e.g. `streamwise_velocity_field`, `current`, `infection_rate`...) 73 | 74 | - Avoid "magic numbers": 75 | 76 | ```C 77 | for (i=0; i<26; i++){ 78 | ``` 79 | 80 | should be instead 81 | 82 | ```C 83 | int AlphabetSize = 26; 84 | for (i=0; i Don't hesitate to use long variable names. All good text editors provide 90 | > [autocompletion](https://en.wikipedia.org/wiki/Autocomplete), which will save you from typing the whole 91 | > of your variables' name. 92 | 93 | 94 | 95 | ### Duplicated code 96 | 97 | Copy-pasting code may speed up development in the short term... **but** 98 | 99 | - It cripples the code's maintainability and extensibility (either by a colleague or yourself three months down the line). 100 | - Each time you modify a part, you have to remember to modify all duplicated parts without forgetting any. Not only it is boring work, but is also error prone. 101 | - Duplicated code also decreases readability, as your code is unnecessarily longer, and makes bug hunting much harder. 102 | 103 | Typical alternatives to duplicated code include: 104 | 105 | - Definition of new functions/methods that can be reused in different parts of the code 106 | - Use of Object Oriented approaches like class inheritance or composition. 107 | 108 | 109 | 110 | ### Complex `if` statements 111 | 112 | Complex `if` statements make your code much less readable, as it forces the reader to hold and process a lot 113 | of information simultaneously. 114 | 115 | As an example, the following `if` statement determines if a point `(x,y)` is contained inside a rectangle: 116 | 117 | ```python 118 | if (x > xmin and x < xmax and y > ymin and y < ymax): 119 | ``` 120 | 121 | The above complex condition can be replaced by a function call: 122 | 123 | ```python 124 | def is_inside_rectangle(x,y): 125 | x_in = x > xmin and x < xmax 126 | y_in = y > ymin and y < ymax 127 | 128 | return x_in and y_in 129 | 130 | # ... 131 | if is_inside_rectangle(x,y): 132 | ``` 133 | 134 | Another common problematic constructs are nested `if-else` statements: 135 | 136 | ```python 137 | nb_of_events = len(events) 138 | if nb_of_events == 1: 139 | list_of_available_events = [] 140 | else: 141 | if events_subsequent: 142 | list_of_available_events = [1] 143 | else: 144 | list_of_available_events = [] 145 | for i in range(nb_of_events): 146 | list_of_available_events.append(i) 147 | ``` 148 | 149 | The above can be better written, using guard clauses, as: 150 | 151 | ```python 152 | def get_list_of_available_events(events, events_subsequent): 153 | nb_of_events = len(events) 154 | if nb_of_events == 1: 155 | return [] 156 | if events_subsequent: 157 | return [1] 158 | return range(nb_of_events) 159 | 160 | list_of_available_events = get_list_of_available_events() 161 | ``` 162 | 163 | Complex `if` statements and nested `if-else` significantly hinder readability. 164 | They also make your code much harder to test, as you'll have to write a test for each possible branch 165 | in your code. 166 | 167 | See the notions of [cyclomatic complexity](https://docs.codeclimate.com/docs/cyclomatic-complexity) and 168 | [cognitive complexity](https://docs.codeclimate.com/docs/cognitive-complexity). 169 | See also [Writing simpler and more maintainable Python by Anthony Shaw (video)](https://youtu.be/dqdsNoApJ80?t=303) 170 | 171 | 172 | 173 | ### Long functions/methods 174 | 175 | - Functions should be as short as possible. 176 | Readability an modularity. 177 | - Functions should do one thing. 178 | Facilitates testing. 179 | 180 | 181 | 182 | ### Obscure lines 183 | 184 | Modern programming language such as Python, Ruby or even modern C++ provide powerful functionality to allow 185 | programmers to do more whilst typing less. Although these can lead to shorter and more descriptive code, it is a double-edged sword. 186 | 187 | Consider the following line of python 188 | 189 | ```python 190 | for ensemble in zip(*[traj_sample(x0, t0, *args, **kwargs) for _ in range(nsamples)]): 191 | ``` 192 | 193 | The above line relies on 194 | 195 | - A generator function call 196 | - List comprehension 197 | - List unpacking 198 | - The `zip` built-in function 199 | 200 | That's a lot. Although this is nice and short, this is difficult to read. Similarly to mathematical proofs, doing too much in one step makes the argument harder to follow. 201 | 202 | In the above, simply adding an extra line allows you to use a descriptive intermediate variable: 203 | 204 | ```python 205 | list_of_generators = [traj_sample(x0, t0, *args, **kwargs) for _ in range(nsamples)] 206 | for ensemble in zip(*list_of_generators): 207 | ``` 208 | 209 | Resist clever one-liners! 210 | 211 | 212 | 213 | ### Unintended behaviour 214 | 215 | A typical example is a function with parameters that are constrained (e.g. strictly positive, integer value...). 216 | The following C function is compiled without errors: 217 | 218 | ```C 219 | double returnArrayElement(int i, double *array){ 220 | 221 | return array[i]; 222 | 223 | } 224 | ``` 225 | 226 | However, if `i` is negative, or larger than the total allocated size of `array`, executing the code may result in a Segmentation Fault. 227 | 228 | > Code should not trust its user, whether the user is a human or some other code. 229 | 230 | The corollary to the above statement is a programming style known as [defensive programming](https://swcarpentry.github.io/python-novice-inflammation/10-defensive/index.html). 231 | 232 | Example of a defensive python function: 233 | 234 | ```python 235 | def compute_acceleration(mass, total_force_on_body): 236 | if mass <= 0: 237 | raise ValueError("Mass of body must be strictly positive") 238 | return total_force_on_body/mass 239 | ``` 240 | 241 | 242 | 243 | ### Undocumented functions, classes and modules 244 | 245 | Any logical structure (function, class, module) should be accompanied by a documentation string (commonly known as *docstring*). 246 | 247 | Example: 248 | 249 | ```python 250 | def compute_acceleration(mass, total_force_on_body): 251 | """ 252 | Compute and return acceleration on body, according to Newton's 2nd law 253 | 254 | Parameters 255 | ---------- 256 | mass: float 257 | Mass of body 258 | total_force_on_body: float 259 | Sum of all forces exerted on the body 260 | 261 | Returns: 262 | -------- 263 | a: float 264 | The acceleration 265 | """ 266 | if mass <= 0: 267 | raise ValueError("Mass of body must be strictly positive") 268 | return total_force_on_body/mass 269 | 270 | ``` 271 | 272 | 273 | 274 | ### Comments 275 | 276 | Commenting can be a confusing topic, since the general advice is *comment you code, but not too much*. 277 | This can be understood by taking a rather *extreme* stance: 278 | 279 | > Good code does not need comments to be understood. 280 | 281 | The rationale is that, most of the time, comments can be avoided by using more descriptive names, shorter methods, and simpler constructs. 282 | 283 | Take home message: comments should describe the *why*, not the *what*. 284 | 285 | 286 | 287 | ### Performance low hanging fruits 288 | 289 | Typical examples include 290 | 291 | - Ordering of nested loops 292 | 293 | It is best to access your data in the order it is laid out in memory. In Fortran, this would mean: 294 | 295 | ```fortran 296 | implicit none 297 | 298 | integer:: i, j 299 | 300 | jloop: do j = 1, mesh_size_y 301 | iloop: do i = 1, mesh_size_y 302 | 303 | ! Make sure inner column index is first 304 | a(i, j) = prefactor(i, j)*(term1(i, j) + term2(i, j)) 305 | 306 | end do iloop 307 | end do jloop 308 | ``` 309 | 310 | See [data spatial locality](https://en.wikipedia.org/wiki/Locality_of_reference)). 311 | 312 | - Use of local variables 313 | 314 | Reusing recently defined variable is fast, thanks to [data temporal locality](https://en.wikipedia.org/wiki/Locality_of_reference). 315 | 316 | ```C++ 317 | for (int i; i 326 | 327 | ### Potential use of built in functions 328 | 329 | Do not not reinvent the wheel! 330 | 331 | Programming languages usually come with useful libraries that implement common tasks. 332 | 333 | ```python 334 | from itertools import accumulate 335 | 336 | accumulate([1,2,3,4,5], initial=100) --> 100 101 103 106 110 115 337 | ``` 338 | 339 | 340 | 341 | ### Potential use of third party libraries 342 | -------------------------------------------------------------------------------- /remote.md: -------------------------------------------------------------------------------- 1 | # Useful tools for remote code reviews 2 | 3 | Face to face code reviews are currently not possible. 4 | Fortunately, there are many solutions to share code over the internet! 5 | 6 | - [Visual Studio Code with Live share plugin](#Visual-Studio-Code-with-Live-share-plugin) 7 | - [tmate](#tmate) 8 | - [Floobits](#Floobits) 9 | - [jitsi for video conferencing](#jitsi-for-videoconferencing) 10 | 11 | ## Visual Studio Code with Live share plugin 12 | 13 | Visual Studio Code is a free cross-platform code editor from Microsoft. 14 | Live share is an extension for Visual Studio Code that enables developers to work collaboratively on a piece of code. 15 | 16 | - [Getting started with Visual Studio code](https://code.visualstudio.com/docs/introvideos/basics) 17 | - [Getting started with Live share for VS code](https://www.digitalocean.com/community/tutorials/how-to-use-live-share-with-visual-studio-code) 18 | 19 | ### License and privacy (Visual Studio Code) 20 | 21 | Although the source code for Visual Studio Code is provided with an open source license (MIT), the binary provided by Microsoft is not. 22 | [The VScodium project](https://vscodium.com/) provides builds of Visual Studio Code released under the MIT license. Particularly, the telemetry included in the binary provided by Microsoft is disabled. 23 | 24 | Similarly to Visual Studio Code, the Live Share extension binary is proprietary software. 25 | The corresponding license can be found [here](https://marketplace.visualstudio.com/items/MS-vsliveshare.vsliveshare/license). 26 | 27 | ## tmate.io 28 | 29 | [tmate](https://tmate.io/) is a tool for sharing terminal sessions over the internet. 30 | It is based on the famous [tmux](https://github.com/tmux/tmux/wiki) **t**erminal **mu**tiple**x**er. 31 | 32 | To start sharing your terminal, simply enter in your terminal 33 | 34 | ```bash 35 | tmate 36 | ``` 37 | 38 | which starts a tmux session inside your terminal (it shouldn't look very different except from the coloured bar at the bottom). 39 | 40 | Next, enter 41 | 42 | ```bash 43 | tmate show-messages 44 | ``` 45 | 46 | ```bash 47 | $ tmate show-messages 48 | Thu May 21 09:49:13 2020 [tmate] Connecting to ssh.tmate.io... 49 | Thu May 21 09:49:13 2020 [tmate] Note: clear your terminal before sharing read-only access 50 | Thu May 21 09:49:13 2020 [tmate] web session read only: https://tmate.io/t/ro-j2nMRX7qmFJePwDgNmvEWC4uQ 51 | Thu May 21 09:49:13 2020 [tmate] ssh session read only: ssh ro-j2nMRX7qmFJePwDgNmvEWC4uQ@lon1.tmate.io 52 | Thu May 21 09:49:13 2020 [tmate] web session: https://tmate.io/t/daSqRGCWXcZkyc9WunwebVXye 53 | Thu May 21 09:49:13 2020 [tmate] ssh session: ssh daSqRGCWXcZkyc9WunwebVXye@lon1.tmate.io 54 | $ 55 | ``` 56 | 57 | To share your terminal, simply share one of the addresses with your collaborator. 58 | For instance, for your collaborator to see your terminal live, their must enter 59 | 60 | ```bash 61 | ssh ro-j2nMRX7qmFJePwDgNmvEWC4uQ@lon1.tmate.io 62 | ``` 63 | 64 | in theirs. 65 | To view it in a web browser, they can visit `https://tmate.io/t/ro-j2nMRX7qmFJePwDgNmvEWC4uQ`. 66 | 67 | - **ssh session read only** (recommended): Join the session through `ssh`, read only mode. 68 | - **web session read only** (most straightforward solution): View terminal through a web browser. Still a bit unstable but when it works, it's great! 69 | - **ssh session read only**: Join the session through `ssh`. The collaborator has write-access to your terminal, and can therefore execute commands on your system! 70 | - **web session** (not recommended): Allow access to your collaborator to your terminal through a web browser. 71 | 72 | **Starting and sharing a tmate session**: 73 | 74 | ![tmate server side](tmate-server-side.gif) 75 | 76 | **Joining a tmate session using ssh:** 77 | 78 | ![tmate client side](tmate-client-side.gif) 79 | 80 | ### Access denied. Check your ssh keys 81 | 82 | To use tmate over ssh, each participant must have their pair of ssh keys set up. 83 | 84 | Here's [a guide](https://www.digitalocean.com/community/tutorials/how-to-set-up-ssh-keys-on-ubuntu-1804) on how to do it (*only step 1 is required for using tmate*). 85 | 86 | ### License and privacy (tmate) 87 | 88 | tmate is released under a free and open source license (BSD). 89 | 90 | Terminal sharing using tmate makes use of the tmate.io servers that act as a proxy between you and your collaborator(s). 91 | The server side of tmate is licensed under the MIT license. 92 | 93 | ## Floobits 94 | 95 | Flootbits ([https://floobits.com/](https://floobits.com/)) let you share and collaboratively edit code over the internet. 96 | It works through a system of work-spaces that users can join. 97 | 98 | The main feature of Floobits is that the service can be used with several widespread text editors: Emacs, Vim(NeoVim), Atom, Sublime and IntelliJ. 99 | In a code review context, this means that both the author and reviewer(s) can work on the code synchronously, each using their favourite text editor. 100 | 101 | Setting up Floobits for a specific editor may require some initial set up. 102 | A very nice alternative is to use the Floobits web-based editor, directly in the web browser. 103 | 104 | Here is an illustration of Floobits where user `otheruser` joins user `tlestang`'s workspace. The former is using the web-based Floobits editor, whilst the latter uses Emacs. 105 | 106 | ![floobits](floobits.gif) 107 | 108 | Floobits provides useful features for code reviews and pair programming in general. 109 | Particularly, is possible to "follow" the cursor of another user. If they change file, you will too. 110 | 111 | ### Getting started with Floobits 112 | 113 | 1. Create an account on [https://floobits.com/](https://floobits.com/) 114 | 1. To share your code, create a workspace and synchronise your local files with it. From the web-editor, *File* -> *Add files*. This can also be done from your local editor. 115 | 1. Files on work-spaces are read-only by default. To grant write permission to another user, go to your Floobits settings page and update your work-space's settings: *Settings* -> *Edit Permissions*. 116 | 1. You can join any public workspace (or private if you were added to it) from your text editor. To join a workspace from the web-based editor, the workspace owner must first add you to it. Then in your Floobits profile, click on *Edit code*. 117 | 118 | ### License and privacy 119 | 120 | Floobits plugins are free/libre and open source software, licensed under the Apache 2.0 license. 121 | Floobits' privacy policy can be found at [https://floobits.com/privacy](https://floobits.com/privacy). 122 | 123 | ## jitsi for videoconferencing 124 | 125 | [jitsi-meet](https://meet.jit.si/) is a web-based free/libre and open source video conferencing app. 126 | -------------------------------------------------------------------------------- /tmate-client-side.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OxfordCodeReviewNet/forum/50543ef35b8be51e9840ac64613555ca7d7af8da/tmate-client-side.gif -------------------------------------------------------------------------------- /tmate-server-side.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OxfordCodeReviewNet/forum/50543ef35b8be51e9840ac64613555ca7d7af8da/tmate-server-side.gif --------------------------------------------------------------------------------