{"id":13837825,"url":"https://github.com/eddiejaoude/book-open-source-tips","last_synced_at":"2025-04-06T01:10:25.620Z","repository":{"id":12822397,"uuid":"72902179","full_name":"eddiejaoude/book-open-source-tips","owner":"eddiejaoude","description":"Open Source book on Open Source Tips","archived":false,"fork":false,"pushed_at":"2023-05-20T07:15:05.000Z","size":1255,"stargazers_count":263,"open_issues_count":37,"forks_count":85,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-05-02T05:40:38.979Z","etag":null,"topics":["book","code","community","github","newcomers","opensource","tips"],"latest_commit_sha":null,"homepage":"https://eddiejaoude.github.io/book-open-source-tips/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eddiejaoude.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["eddiejaoude"]}},"created_at":"2016-11-05T03:15:33.000Z","updated_at":"2024-08-04T15:49:21.725Z","dependencies_parsed_at":"2024-08-04T15:49:18.605Z","dependency_job_id":"93f93cad-8e33-409f-8571-515fb763a505","html_url":"https://github.com/eddiejaoude/book-open-source-tips","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddiejaoude%2Fbook-open-source-tips","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddiejaoude%2Fbook-open-source-tips/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddiejaoude%2Fbook-open-source-tips/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddiejaoude%2Fbook-open-source-tips/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eddiejaoude","download_url":"https://codeload.github.com/eddiejaoude/book-open-source-tips/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247419861,"owners_count":20936012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","code","community","github","newcomers","opensource","tips"],"created_at":"2024-08-04T15:01:27.453Z","updated_at":"2025-04-06T01:10:25.603Z","avatar_url":"https://github.com/eddiejaoude.png","language":"Makefile","readme":"[![DashboardHub](https://img.shields.io/badge/DashboardHub-Open%20Source%20Book-orange.svg)](https://pipeline.dashboardhub.io/environments/f39a2d40-2045-11e8-a435-ade829eb4121)\n\n# Open Source Tips\n\nOpen Source book on Open Source Tips\n\n| Language | Status | Link |\n| :--- | :--- | :--- |\n| English | - | https://eddiejaoude.github.io/book-open-source-tips/ |\n| Spanish | In progress | https://eddiejaoude.github.io/book-open-source-tips/index-es.html |\n| Filipino | In progress | https://eddiejaoude.github.io/book-open-source-tips/index-fil.html |\n\nThis book contains some common **DOs** \u0026 **DON'Ts** for Open Source software.\n\nThe Open Source community is thriving. Each day the number of Open Source projects grow, as does the army of contributors that maintain them. While this is exciting for the industry, it can be daunting as a developer new to the community. This book aims to provide some tips for newcomers to help them avoid the pitfalls of Open Source development and learn from the community's collective wisdom.\n\nAs the ancient proverb goes, _Time and tide [and technology] wait for no man_. And to the best of our ability, neither will this book. Remember to check the version number for updates!\n\nWe would love your help in keeping this book updated. Your comments, suggestions, and pull requests are most welcome.\n\nOpen Source is dominating the software industry. Its champions include well-known organisations like Facebook, Twitter and Netflix, but more significantly, an army of passionate individual developers around the world. Their efforts have impacted almost every part of computer science, culminating in millions of open source projects, with billions of lines of code!\n\nWhile this abundant ecosystem has been of huge benefit to the whole industry, it can also make it difficult for newcomers to know where to start. If you're a newcomer, you might be faced with questions such as _\"How can I contribute to the Open Source community?\"_ Or, _\"How do I choose between so many competing projects?\"_ The following DOs and DON'Ts aim to address some of those basic questions, and offer some pointers to aspiring Open Source developers.\n\n[Let's dive right in](https://eddiejaoude.github.io/book-open-source-tips/).\n\nAll changes in `master` branch are automatically deployed to the above URL.\n\n## Code of Conduct\n\n* [Code of Conduct](.github/CODE_OF_CONDUCT.md)\n\n## Dependencies\n\n* [Ascii Doctor](http://asciidoctor.org)\n\n## Quick Start\n\n### Install\n\n* AsciiDoctor (html)\n\n```bash\ngem install asciidoctor\n```\n\n* AciiDoctor (pdf)\n\n```bash\ngem install --pre asciidoctor-pdf\n```\n\n* Atom preview [plugin](https://atom.io/packages/asciidoc-preview) (optional)\n\n```bash\napm install asciidoc-preview\n```\n\n* VS Code preview [plugin](https://marketplace.visualstudio.com/items?itemName=joaompinto.asciidoctor-vscode) (optional)\n\nLaunch VS Code Quick Open (Windows: `ctrl+p`, Mac: `cmd+p`), paste the following command, and press enter:\n\n```bash\next install joaompinto.asciidoctor-vscode\n```\n\n### Source code\n\nSource code is in `src/` directory.\n\n### Generate html, pdf etc\n\n* To generate the output in **html** \u0026 **pdf**:\n\n```bash\nmake\n```\n\n![Generated pdf](https://cloud.githubusercontent.com/assets/624760/20028256/e127f148-a345-11e6-9871-5e40a7c73edb.png)\n\n![Generated html](https://cloud.githubusercontent.com/assets/624760/20028253/cfd770c6-a345-11e6-8552-88904ecca9dc.png)\n\n\n### Live Server in Codespace\n\nIf you are opening up in GitHub Codespace or VSCode with a DevContainer, then Live Server extension is installed and the port mapping to 5500 setup. Just start liveshare through the command pallet or with 'alt + l then alt + o' then go to remote explorer and open the Live Server in a new browser tab. \n","funding_links":["https://github.com/sponsors/eddiejaoude"],"categories":["Makefile"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddiejaoude%2Fbook-open-source-tips","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feddiejaoude%2Fbook-open-source-tips","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddiejaoude%2Fbook-open-source-tips/lists"}