Open Source Tips

Open Source book on Open Source Tips

This book contains some common DOs & DON'Ts for Open Source software.

The 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.

As 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!

We would love your help in keeping this book updated. Your comments, suggestions, and pull requests are most welcome.

Open 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!

While 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.

Let's dive right in.

All changes in master branch are automatically deployed to the above URL.

Code of Conduct

• Code of Conduct

Dependencies

• Ascii Doctor

Quick Start

Install

• AsciiDoctor (html)

gem install asciidoctor

• AciiDoctor (pdf)

gem install --pre asciidoctor-pdf

• Atom preview plugin (optional)

apm install asciidoc-preview

• VS Code preview plugin (optional)

Launch VS Code Quick Open (Windows: ctrl+p, Mac: cmd+p), paste the following command, and press enter:

ext install joaompinto.asciidoctor-vscode

Source code

Source code is in src/ directory.

Generate html, pdf etc

• To generate the output in html & pdf:

make

Live Server in Codespace

If 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.