We are building new navigation standards for a better visualization and understanding of code.
First and foremost, Thank you for visiting the No Comments project repository! 🎉
If you're interested to know more about this project, this document will give you all the information you need. So, just jump on one of the topics mentioned below or just keep scrolling!
- Introduction
- Why are we doing this?
- How are we doing it?
- What do we need?
- How can you get involved?
- MozSprint
- Participation Guidelines
- License
- Get in touch
No Comments is a project being developed under the Mozilla Open Leaders Program and mentored by Pranshu Khanna.
We are working with designers and developers to create IDE plug-ins for students and budding developers that will convert your sorce code into a flow chart at real time. The aim of this project is to create a better navigation of your code, to make the manually entered comments more efficient and to give students the confidence to code anything and everything!
- Lack of relative visual logic to the code a newbie developer writes to practice.
- Collaborative lapses in organizations due to unthorough comments.
-
Using flowcharts!! Yes, that's right. 🤘
-
Transitioning from textbook to code doesn't pan out well for most students since they can't relate to it very often. This can help them understand how their chunk of code puts together a logic in real time and the output they expect to create.
-
Creating a navigational flowchart helps understand a developer about how others' code connects with theirs in a collaborative environment.
No Comments aims to create a plug-in for Atom, it is a free and open-source text and source code editor. A plug-in that would convert a code into a SVG flowchart in real time. We will start with focusing on one language but would want this plug-in to be expanded and support multiple coding languages in the future. We would need developers and contributors to who can drive this forward and create such plug-ins in Atom.
If you have any questions or would like to discuss more about the goals of this project, come and say, Hi to us! 🙋
If you think you can help in any of the areas to turn this vision into reality (and we bet you can) or in any areas that we haven't yet thought of then please check out our contributors' guidelines and our roadmap.
Any help with the code, idea, feedback anything at all that you think would be of help, is most welcome and much appreciated. If you’re interested in the project, feel free to open an issue and create a PR!
Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our code of conduct in all interactions both on and offline.
Join us at the Mozilla's Global Sprint May 10-11, 2018! We'll be gathering in-person at sites around the world and online to collaborate on this project and learn from each other. Get your #mozsprint tickets now!
We are following Mozilla Community Participation Guidelines, please have a look at it here.
This project is licensed under the GNU General Public License - you can see LICENSE file for details.
If you want to report a problem or suggest an enhancement we'd love for you to open an issue at this github repository.
You can also contact Shina by email (shina DOT dhingra 11 AT gmail DOT com) or on twitter.
You can also ask questions and tell us more about yourself in the No Comments OL7 room on Gitter.
Thank you so much for visiting the project and we do hope that you'll join us on this amazing journey!❤️