Code Monkey home page Code Monkey logo

readme-template's People

Contributors

abelg101 avatar davidauza-engineer avatar fernandorpm avatar kethinov avatar nidalaa avatar noergitkat avatar shreyadm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

readme-template's Issues

Why MIT.md instead of LICENSE?

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

Readme paths redirecting to the wrong page

Readme paths redirecting to the wrong page

Both the Linkedin profile URL and the issues page URL takes the user to non-existent pages (404)

Why change it on the template instead of relying on the developer

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.

Linkedin Profile Page URL

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

Issues Page on Github URL

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

Additional suggestions ๐Ÿš€

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.

README, under table of contents: Deployment link broken

Hello there ๐Ÿ‘‹,

  • I noticed the "deployment" link is set to the wrong path, it's set to "triangular_flag_on_post-deployment" and that doesn't work.
  • I believe it should be set to "#deployment" as that works. โ˜บ
  • I've created a PR here, if you could kindly check and merge it.

Add PR template

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?

Pull request

I have trouble trying to create a new pull request.

readme

issue is created for learning purpose

Table content position

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.