DEV Community

loading...
Cover image for CONTRIBUTING: Wassim Chegham on Compodoc
For Devs community

CONTRIBUTING: Wassim Chegham on Compodoc

Sherry List 🏡 🇩🇰
Azure Developer Technical Lead @microsoft | @WomenTechMakers Lead | Organizer: @ngCopenhagen, @ngVikingsConf & @ngSpain
・2 min read

Leading up to (and during) the month of October, we want to help you discover open source projects to work on, and put your Hacktoberfest contributions to excellent use. Meet Wassim Chegham senior cloud advocate at Microsoft & core contributor to Compodoc.

Check out this page regularly for more interviews with contributors & maintainers

Hi I'm Wassim senior cloud advocate at Microsoft. The project I'm going to present you today is Compodoc.

What can you tell us about your project?
Compodoc is a documentation generator tool that is written for Angular or any TypeScript application.
You would basically use it to automatically generate application from your Angular code or your Angular app and you would have this nice website with your whole documentation generated and extracted from your Angular code auto magically for you.
Compodoc helps Angular developers providing a clear and helpful documentation of their application.
Others developers of your team, or internet visitors for a public documentation, can easily understand the features of your application or library.

What contributions are you welcoming?
We're actually welcoming any kind of contributions. You can help us in fixing typos in the readme or on the website itself. You can also contribute by adding new unit tests or fixing our broken unit tests.
Also, we need your help with improving our own documentation for Compodoc or whether like to add missing features or let us know about these missed features.

What skills do people need to contribute?
Compodoc is a CLI tool which means it's a command-line interface tool written in TypeScript and then runs on top of Node.JS. So, familiarities with TypeScript, JavaScript and CLI would be great.
It would be great if you know how to access the file system from Node.JS or manipulate files via it.
Otherwise any basic knowledge with JavaScript or TypeScript and Node.JS.

How do I get started?
In order to get started you could go to Compodoc.app which is the the official website and the best place to familiarities yourself with the project. You could also clone and install the tool locally and run it against any Angular application.
Otherwise you can go on the GitHub repo of Compodoc and check all the open issues. Some of them are labeled with the oktoberfest.
You are welcome to start with those.
Otherwise feel free to pick up any um to pick any.

Thank you very much 🙏

Wassim Chegham

Join, October 2nd, for CONTRIBUTING.md - a virtual Hacktoberfest meetup, free and open for anyone who wants to join. Learn what Open Source projects are looking for contributions, which communities are looking for new members, and who is looking for advice from someone with your exact skill set. Check this page regularly for more interviews with contributors & maintainers which we'll release until the event.

Discussion (0)