microverseinc / readme-template Goto Github PK
View Code? Open in Web Editor NEWA README template that can be used to give any project clear documentation.
A README template that can be used to give any project clear documentation.
As far as I have have seen, the convention for filename containing license is either LICENSE or COPYING. I wanted to know what is the rationale behind naming the license file MIT.md
?
In order to follow the convention I suggest to consider renaming the file (and update README.md accordingly).
Both the Linkedin profile URL and the issues page URL takes the user to non-existent pages (404)
The template should be as straightforward as possible, and avoid as many confusions as possible.
Microverse can be quite challenging when you first get into it with all of its requirements, documentation, and so on, so we should always try to remove as many burdens as we can from our students' backs.
How it is right now:
- LinkedIn: [LinkedIn](https://linkedin.com/linkedinhandle)
How it should be:
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
This way all that is required to change is the handle
How it is right now:
Feel free to check the [issues page](issues/).
How it should be:
Feel free to check the [issues page](../../issues/).
This way nothing has to be done on the developer's side
Add an MIT Template file as well. It could even be pointed out that students should always try to improve the file and have their own default MIT file. But for starters, it is a timesaver, especially if we consider that not all code reviewers actually ask them to update/fix the link, and for their first requested changes, they most likely won't even know where to look at it or what're they talking about.
Would be good to have some PR template. We have made one which we think it looks fine. Should be send PR to this repo for it? If not, where is the good place for it?
I have trouble trying to create a new pull request.
issue is created for learning purpose
In the table of content inside Getting Started, you can see the Setup link before the Prerequisites link. When you go to the document it is opposite, first come Prerequisites and then Setup.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.