|
51 | 51 | "\n", |
52 | 52 | "To set up a GitHub profile, simply head to the main page and click [Sign Up for GitHub](https://github.com/join). Here, you can create your personal account, with a username, email, and password as standard.\n", |
53 | 53 | "\n", |
54 | | - "\n", |
| 54 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/github_signup.png\" width=\"800\" /></p>\n", |
55 | 55 | "\n", |
56 | 56 | "<p align=\"center\"><i>Sign up for GitHub</i></p>\n", |
57 | 57 | "\n", |
|
98 | 98 | "\n", |
99 | 99 | "On your GitHub profile, click the 'Create new repository'. The first step is to create a name as the brand for your project. Ideally, it should be memorable and give some indication of what the project does.\n", |
100 | 100 | "\n", |
101 | | - "\n", |
| 101 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/new_repo.png\" width=\"800\" /></p>\n", |
102 | 102 | "\n", |
103 | 103 | "<p align=\"center\"><i>Create a new repository</i></p>\n", |
104 | 104 | "\n", |
|
128 | 128 | "3. CONTRIBUTING.md\n", |
129 | 129 | "4. CODE_OF_CONDUCT.md\n", |
130 | 130 | "\n", |
131 | | - "\n", |
| 131 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/foundation.png\" width=\"800\" /></p>\n", |
132 | 132 | "\n", |
133 | 133 | "<p align=\"center\"><i>The basic repository structure</i></p>\n", |
134 | 134 | "\n", |
|
148 | 148 | "\n", |
149 | 149 | "Thankfully, when you start a new repository on GitHub, you are given the option to select an existing license from a drop-down menu. You should always (with very few exceptions) use an existing license, since this is what potential users and contributors will see before they choose to use or contribute to your software.\n", |
150 | 150 | "\n", |
151 | | - "\n", |
| 151 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/license.png\" width=\"800\" /></p>\n", |
152 | 152 | "\n", |
153 | 153 | "<p align=\"center\"><i>Choosing an example license</i></p>\n", |
154 | 154 | "\n", |
|
162 | 162 | "\n", |
163 | 163 | "When you initialise your new repository, there should be an option to do so with a README file. Just like Alice in Wonderland, these do exactly what they say - provide key information about the project. These are typically the first thing outside contributors will see when they come to your repository, so making them informative and welcoming is key.\n", |
164 | 164 | "\n", |
165 | | - "\n", |
| 165 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/readme.png\" width=\"800\" /></p>\n", |
166 | 166 | "\n", |
167 | 167 | "<p align=\"center\"><i>Part of the README file for this module</i></p>\n", |
168 | 168 | "\n", |
|
193 | 193 | "\n", |
194 | 194 | "Contributing guidelines are designed to communicate to potential contributors a short guide on how to engage with your project and community. You want to make sure to be welcoming, and indicate that you are eager for participants to engage with your project. Whenever a participant opens a new pull request or creates a new issue, they will see a link to your contribution file.\n", |
195 | 195 | "\n", |
196 | | - "\n", |
| 196 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/contributing.png\" width=\"800\" /></p>\n", |
197 | 197 | "\n", |
198 | 198 | "<p align=\"center\"><i>Part of the CONTRIBUTING guidelines for this module</i></p>\n", |
199 | 199 | "\n", |
|
227 | 227 | "\n", |
228 | 228 | "To add a code of conduct, you can create your own from scratch by adding a new markdown file, or use existing templates such as the [Contributor Covenant](https://contributor-covenant.org/). Name your file CODE_OF_CONDUCT.md, and make sure it is visible in the README file.\n", |
229 | 229 | "\n", |
230 | | - "\n", |
| 230 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/code_of_conduct.png\" width=\"800\" /></p>\n", |
231 | 231 | "\n", |
232 | 232 | "<p align=\"center\"><i>Part of the CODE OF CONDUCT file for this module, based on the Contributor Covenant</i></p>\n", |
233 | 233 | "\n", |
|
259 | 259 | "* Assignees indicate who is responsible for working on an issue;\n", |
260 | 260 | "* Comments for providing feedback.\n", |
261 | 261 | "\n", |
262 | | - " [source](https://open-scholarship-strategy.github.io/site/)\n", |
| 262 | + "<p align=\"center\"><img src=\"https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/images/issues.png\" width=\"800\" /></p>\n", |
263 | 263 | "\n", |
264 | 264 | "<p align=\"center\"><i>The issue tracker for the Open Scholarship Strategy project</i></p>\n", |
265 | 265 | "\n", |
|
297 | 297 | ] |
298 | 298 | } |
299 | 299 | ], |
300 | | - "metadata": { |
301 | | - "kernelspec": { |
302 | | - "display_name": "Python 3", |
303 | | - "language": "python", |
304 | | - "name": "python3" |
305 | | - }, |
306 | | - "language_info": { |
307 | | - "codemirror_mode": { |
308 | | - "name": "ipython", |
309 | | - "version": 3 |
310 | | - }, |
311 | | - "file_extension": ".py", |
312 | | - "mimetype": "text/x-python", |
313 | | - "name": "python", |
314 | | - "nbconvert_exporter": "python", |
315 | | - "pygments_lexer": "ipython3", |
316 | | - "version": "3.6.5" |
317 | | - } |
318 | | - }, |
| 300 | + "metadata": {}, |
319 | 301 | "nbformat": 4, |
320 | 302 | "nbformat_minor": 2 |
321 | 303 | } |
0 commit comments