machines/howtos/contribute-to-open-source-projects/config.json
2025-09-12 11:19:33 +02:00

428 lines
23 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"total_views": 104,
"moderation": "accepted",
"_id": "pO7a4mMf8WpYZAUlLxl6",
"files": [],
"time": "< 1 hour",
"slug": "contribute-to-open-source-projects",
"_created": "2023-10-21T09:54:29.281Z",
"_createdBy": "darigov-research",
"mentions": [],
"title": "Contribute to open source projects",
"steps": [
{
"title": "Find a project",
"text": "First find a project. You can take a look at some of our open source projects as we have many and are very welcoming to all collaborators. One army has many open source projects and from experience they are very welcoming too!\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/[filtered]\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/[filtered]</a>\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/darigovresearch/\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/darigovresearch</a>\n",
"_animationKey": "unique1",
"images": [
{
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/1_find_a_project.png",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F1_find_a_project.png?alt=media&token=42e7ad83-784e-4a5b-851e-df7aefec98da",
"updated": "2020-12-07T22:30:50.693Z",
"contentType": "image/jpeg",
"size": 70918,
"timeCreated": "2020-12-07T22:30:50.693Z",
"name": "1_find_a_project.png",
"type": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\1_find_a_project.png",
"alt": "1_find_a_project.png"
}
]
},
{
"images": [
{
"updated": "2020-12-07T22:30:52.218Z",
"size": 74312,
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F2_readme.png?alt=media&token=3091f7d0-74fd-46fd-be81-24f8b0c502d7",
"name": "2_readme.png",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/2_readme.png",
"contentType": "image/jpeg",
"timeCreated": "2020-12-07T22:30:52.218Z",
"type": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\2_readme.png",
"alt": "2_readme.png"
},
{
"name": "2_contributing_guideline.png",
"size": 85951,
"contentType": "image/jpeg",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F2_contributing_guideline.png?alt=media&token=f25a56d1-a15a-4c4e-890b-e0ddb85952d8",
"updated": "2020-12-07T22:30:52.121Z",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/2_contributing_guideline.png",
"type": "image/jpeg",
"timeCreated": "2020-12-07T22:30:52.121Z",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\2_contributing_guideline.png",
"alt": "2_contributing_guideline.png"
}
],
"text": "Take a look at the read the readme & contributing guidelines. These can give you guidance on what is expected from a pull request in order for it to be merged back.",
"_animationKey": "unique2",
"title": "Readme & contributing guide"
},
{
"_animationKey": "unique3",
"text": "See the open issues to see if theres anything you can do. We recommend finding something that is quick and simple to fix, particularly if its the first time youre contributing to a project.",
"title": "View the issues",
"images": [
{
"updated": "2020-12-07T22:30:53.388Z",
"name": "3_view_the_issues.png",
"timeCreated": "2020-12-07T22:30:53.388Z",
"size": 81601,
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F3_view_the_issues.png?alt=media&token=f96e2516-8923-45d5-a068-845ad8ff307d",
"contentType": "image/jpeg",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/3_view_the_issues.png",
"type": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\3_view_the_issues.png",
"alt": "3_view_the_issues.png"
}
]
},
{
"title": "Sign in/Sign up",
"_animationKey": "uniqueq6cg3q",
"images": [
{
"updated": "2020-12-07T23:02:03.007Z",
"name": "4_sign_in.png",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F4_sign_in.png?alt=media&token=e6d0ee40-5407-4717-ac49-aaef0b2da97d",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/4_sign_in.png",
"size": 32112,
"timeCreated": "2020-12-07T23:02:03.007Z",
"type": "image/jpeg",
"contentType": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\4_sign_in.png",
"alt": "4_sign_in.png"
}
],
"text": "Make an account for the service provided or sign in if you have one already, just follow the steps in the UI and you should be fine."
},
{
"images": [
{
"timeCreated": "2020-12-07T23:02:04.750Z",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F5_fork.png?alt=media&token=52ecaa71-e23e-4bbd-8dbb-d09a74c5aa20",
"updated": "2020-12-07T23:02:04.750Z",
"contentType": "image/jpeg",
"type": "image/jpeg",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/5_fork.png",
"size": 83200,
"name": "5_fork.png",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\5_fork.png",
"alt": "5_fork.png"
}
],
"title": "Fork the repository",
"text": "This is done by clicking the fork button while signed in on the repository youre interested in contributing to. Youll know its yours as youll have your account name in the URL and at the top of the page.",
"_animationKey": "unique31k2ku"
},
{
"title": "Make changes",
"images": [
{
"size": 87664,
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/6_edit_file.png",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F6_edit_file.png?alt=media&token=ad34081f-5141-43fc-ab42-b1e7d8f415c7",
"updated": "2020-12-07T23:02:06.316Z",
"contentType": "image/jpeg",
"type": "image/jpeg",
"name": "6_edit_file.png",
"timeCreated": "2020-12-07T23:02:06.316Z",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\6_edit_file.png",
"alt": "6_edit_file.png"
},
{
"contentType": "image/jpeg",
"name": "6_preview_changes.png",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F6_preview_changes.png?alt=media&token=f88ee1c8-4da1-4363-bb4e-2f0e10c74a3e",
"timeCreated": "2020-12-07T23:02:06.285Z",
"updated": "2020-12-07T23:02:06.285Z",
"size": 70839,
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/6_preview_changes.png",
"type": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\6_preview_changes.png",
"alt": "6_preview_changes.png"
},
{
"type": "image/jpeg",
"size": 56640,
"timeCreated": "2020-12-07T23:02:05.759Z",
"updated": "2020-12-07T23:02:05.759Z",
"contentType": "image/jpeg",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F6_commit_message.png?alt=media&token=efa6006a-5e4a-48eb-91b4-fe7eedaedfc1",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/6_commit_message.png",
"name": "6_commit_message.png",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\6_commit_message.png",
"alt": "6_commit_message.png"
}
],
"text": "This can be done in the browser or on your local computer.\n\nIn the browser you can edit the files by clicking on the file name & then the edit button. It will open a new page where you can edit it & preview the changes. If youre uploading many files you can use the upload button & drag and drop them. Youll need to add a message for what changes youre making in the bottom of the page.\n\nTo edit on your local computer you will need to clone your repository, make the updates locally, commit to the repository & push back to the server. If youre working on a GitHub project if you want to work on it locally we recommend using the desktop app as it is quite intuitive and open source too!",
"_animationKey": "uniquemhp6z"
},
{
"_animationKey": "uniquejfodyy",
"title": "Make a pull request",
"images": [
{
"size": 80701,
"updated": "2020-12-07T23:02:07.969Z",
"timeCreated": "2020-12-07T23:02:07.969Z",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/7_pull_request.png",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F7_pull_request.png?alt=media&token=9461d93d-b004-467b-b7bc-65a9c97c08e5",
"contentType": "image/jpeg",
"name": "7_pull_request.png",
"type": "image/jpeg",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\7_pull_request.png",
"alt": "7_pull_request.png"
},
{
"timeCreated": "2020-12-07T23:02:07.719Z",
"type": "image/jpeg",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/7_template.png",
"contentType": "image/jpeg",
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F7_template.png?alt=media&token=008e88c6-0530-4b2b-8f6b-4488126709ad",
"name": "7_template.png",
"updated": "2020-12-07T23:02:07.719Z",
"size": 79544,
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\7_template.png",
"alt": "7_template.png"
},
{
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F7_complete_pull_request.png?alt=media&token=402a299c-e414-4b9a-8453-f54b54f167df",
"contentType": "image/jpeg",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/7_complete_pull_request.png",
"name": "7_complete_pull_request.png",
"timeCreated": "2020-12-07T23:02:07.758Z",
"updated": "2020-12-07T23:02:07.758Z",
"type": "image/jpeg",
"size": 79748,
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\7_complete_pull_request.png",
"alt": "7_complete_pull_request.png"
}
],
"text": "Follow any templates or guidelines thats in the repository, give it a name that is understandable and a small succinct descriptions of the fixes or changes youve made. You can reference any issues by putting the issue number and it will automatically link it to the relevant issue for context. You may need to iterate based on the auto-generated tests (if they have any) or feedback given by the original repository maintainers."
},
{
"images": [],
"_animationKey": "uniquewfmic9",
"videoUrl": "https://www.youtube.com/watch?v=UWA4wyacY2A",
"text": "Now hopefully it will be merged by the repository maintainers and you will have officially contributed to open source!\n\nIf you need more details do take a look at the video that this how-to is based off.\n\nCheck out the One Army GitHub page for repositories you can contribute to!\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/[filtered]\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/[filtered]</a>\n\nIf you need some wider context on other open source projects you can take a look at our website and our GitHub as well!\n\n<a class=\"text-orange-600 underline\" href=\"https://www.darigovresearch.com/\" target=\"_blank\" rel=\"noopener noreferrer\">darigovresearch.com: darigovresearch.com</a>\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/darigovresearch/\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/darigovresearch</a>\n",
"title": "Wait for it to be Merged"
}
],
"creatorCountry": "gb",
"cover_image": {
"downloadUrl": "https://firebasestorage.googleapis.com/v0/b/onearmyworld.appspot.com/o/uploads%2Fhowtos%2FpO7a4mMf8WpYZAUlLxl6%2F0_Intro_title.png?alt=media&token=2755544f-de30-462a-a339-bd5bc9fd2f8d",
"fullPath": "uploads/howtos/pO7a4mMf8WpYZAUlLxl6/0_Intro_title.png",
"size": 34091,
"updated": "2020-12-07T22:30:49.144Z",
"contentType": "image/jpeg",
"type": "image/jpeg",
"timeCreated": "2020-12-07T22:30:49.144Z",
"name": "0_Intro_title.png",
"src": "C:\\Users\\zx\\Desktop\\osr\\osr-machines\\howtos\\contribute-to-open-source-projects\\0_intro_title.png"
},
"fileLink": "",
"_contentModifiedTimestamp": "2023-10-21T09:54:29.281Z",
"description": "Getting started with contributing to open source projects may seem a little daunting so we wrote a quick guide. This focuses on GitHub based projects as it is a core bit of software for collaborating on open source projects.",
"tags": [
"product",
"starterkit",
"research"
],
"previousSlugs": [
"contribute-to-open-source-projects"
],
"moderatorFeedback": "",
"_modified": "2023-11-01T13:22:26.415Z",
"votedUsefulBy": [
"marcelaazoubel",
"vermaylen"
],
"total_downloads": 0,
"_deleted": false,
"difficulty_level": "Easy",
"comments": [],
"user": {
"moderation": "accepted",
"_deleted": false,
"_id": "darigov-research",
"_modified": "2023-10-22T21:03:38.018Z",
"type": "machine-builder",
"location": {
"lat": 51.5204,
"lng": -0.1218
},
"verified": false,
"_created": "2023-10-22T21:03:38.018Z",
"geo": {
"latitude": 51.5204,
"lookupSource": "coordinates",
"longitude": -0.1218,
"localityLanguageRequested": "en",
"continent": "Europe",
"continentCode": "EU",
"countryName": "United Kingdom of Great Britain and Northern Ireland (the)",
"countryCode": "GB",
"principalSubdivision": "England",
"principalSubdivisionCode": "GB-ENG",
"city": "London",
"locality": "Camden Town",
"postcode": "WC1N 3",
"plusCode": "9C3XGVCH+57",
"localityInfo": {
"administrative": [
{
"name": "United Kingdom of Great Britain and Northern Ireland (the)",
"description": "country in Western Europe",
"isoName": "United Kingdom of Great Britain and Northern Ireland (the)",
"order": 3,
"adminLevel": 2,
"isoCode": "GB",
"wikidataId": "Q145",
"geonameId": 2635167
},
{
"name": "England",
"description": "home nation of the United Kingdom",
"isoName": "England",
"order": 6,
"adminLevel": 4,
"isoCode": "GB-ENG",
"wikidataId": "Q21",
"geonameId": 6269131
},
{
"name": "London",
"description": "capital and largest city of England and the United Kingdom",
"order": 7,
"adminLevel": 5,
"wikidataId": "Q84",
"geonameId": 2643743
},
{
"name": "Greater London",
"description": "administrative area and ceremonial county in England",
"order": 8,
"adminLevel": 5,
"wikidataId": "Q23306",
"geonameId": 2648110
},
{
"name": "Camden Town",
"description": "borough in the London Region in England",
"order": 10,
"adminLevel": 8,
"wikidataId": "Q202088",
"geonameId": 3345437
},
{
"name": "Camden",
"description": "borough in the London Region in England",
"isoName": "Camden",
"order": 11,
"adminLevel": 8,
"isoCode": "GB-CMD",
"wikidataId": "Q202088",
"geonameId": 3333138
}
],
"informative": [
{
"name": "Europe",
"description": "continent",
"isoName": "Europe",
"order": 1,
"isoCode": "EU",
"wikidataId": "Q46",
"geonameId": 6255148
},
{
"name": "British Isles",
"description": "group of islands in northwest Europe",
"order": 2,
"wikidataId": "Q38272",
"geonameId": 2654669
},
{
"name": "Europe/London",
"description": "time zone",
"order": 4
},
{
"name": "Great Britain",
"description": "island in the North Atlantic Ocean off the northwest coast of continental Europe",
"order": 5,
"wikidataId": "Q23666",
"geonameId": 2648147
},
{
"name": "Middlesex",
"description": "historic county of England",
"order": 9,
"wikidataId": "Q19186",
"geonameId": 2642605
},
{
"name": "WC1N 3",
"description": "postal code",
"order": 12
}
]
}
},
"data": {
"urls": [
{
"name": "Website",
"url": "https://darigovresearch.com/"
},
{
"name": "Social media",
"url": "https://github.com/darigovresearch/"
},
{
"name": "Twitter",
"url": "https://twitter.com/darigovresearch"
},
{
"name": "Instagram",
"url": "https://www.instagram.com/darigovresearch"
},
{
"name": "Bazar",
"url": "https://bazar.preciousplastic.com/darigov-research-limited/"
},
{
"name": "Social media",
"url": "https://www.patreon.com/darigovresearch"
},
{
"name": "sponsor the work",
"url": "https://www.patreon.com/one_army"
}
],
"description": "We specialise in open source hardware, software and education to help people tackle global issues in their local community.\n\nOur members have been building the machines since V2 and have been running workshops to help people understand and get started with the Precious Plastic tools.\n\nMachines we build\n-Injection Machine\n-Shredder Machine\n-Extrusion Machine\n-Compression Machine",
"services": [
{
"welding": true,
"assembling": true,
"machining": true,
"electronics": true,
"molds": true
}
],
"title": "Darigov Research",
"images": []
},
"detail": {
"services": [],
"urls": []
}
},
"category": {
"label": "uncategorized"
},
"content": "Getting started with contributing to open source projects may seem a little daunting so we wrote a quick guide. This focuses on GitHub based projects as it is a core bit of software for collaborating on open source projects.\n\n\nUser Location: London, United Kingdom of Great Britain and Northern Ireland (the)\n\nFirst find a project. You can take a look at some of our open source projects as we have many and are very welcoming to all collaborators. One army has many open source projects and from experience they are very welcoming too!\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/[filtered]\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/[filtered]</a>\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/darigovresearch/\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/darigovresearch</a>\n\n\nTake a look at the read the readme & contributing guidelines. These can give you guidance on what is expected from a pull request in order for it to be merged back.\n\nSee the open issues to see if theres anything you can do. We recommend finding something that is quick and simple to fix, particularly if its the first time youre contributing to a project.\n\nMake an account for the service provided or sign in if you have one already, just follow the steps in the UI and you should be fine.\n\nThis is done by clicking the fork button while signed in on the repository youre interested in contributing to. Youll know its yours as youll have your account name in the URL and at the top of the page.\n\nThis can be done in the browser or on your local computer.\n\nIn the browser you can edit the files by clicking on the file name & then the edit button. It will open a new page where you can edit it & preview the changes. If youre uploading many files you can use the upload button & drag and drop them. Youll need to add a message for what changes youre making in the bottom of the page.\n\nTo edit on your local computer you will need to clone your repository, make the updates locally, commit to the repository & push back to the server. If youre working on a GitHub project if you want to work on it locally we recommend using the desktop app as it is quite intuitive and open source too!\n\nFollow any templates or guidelines thats in the repository, give it a name that is understandable and a small succinct descriptions of the fixes or changes youve made. You can reference any issues by putting the issue number and it will automatically link it to the relevant issue for context. You may need to iterate based on the auto-generated tests (if they have any) or feedback given by the original repository maintainers.\n\nNow hopefully it will be merged by the repository maintainers and you will have officially contributed to open source!\n\nIf you need more details do take a look at the video that this how-to is based off.\n\nCheck out the One Army GitHub page for repositories you can contribute to!\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/[filtered]\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/[filtered]</a>\n\nIf you need some wider context on other open source projects you can take a look at our website and our GitHub as well!\n\n<a class=\"text-orange-600 underline\" href=\"https://www.darigovresearch.com/\" target=\"_blank\" rel=\"noopener noreferrer\">darigovresearch.com: darigovresearch.com</a>\n\n<a class=\"text-orange-600 underline\" href=\"https://github.com/darigovresearch/\" target=\"_blank\" rel=\"noopener noreferrer\">github.com: github.com/darigovresearch</a>\n"
}