anshumanv / evolutions-webapp

What? monferno is evolving!
https://evolutions.js.org
MIT License
17 stars 17 forks source link

Contributing readme #3

Closed sneakycrowllc closed 7 years ago

sneakycrowllc commented 7 years ago

I think it might be a good idea to create a Contributing.md file for the contributors. Just some rules and guidelines πŸ˜„

anshumanv commented 7 years ago

Right, let's get one !

anshumanv commented 7 years ago

Also add build & run guidelines in README.md

sneakycrowllc commented 7 years ago

Yes! I'll let you make the CONTRIBUTING.md file since it's your repo and I figured you have a way of doing things πŸ˜„. I think we should maybe move the current README.md (which is the default readme shipped with create-react-app) to a REACT-README.md file for example. Then put the build guidelines, run guidelines, and project information in README.md.

anshumanv commented 7 years ago

Oh I didn't know create-react-app ships a readme.md of it's own, thanks for letting me know ! The current readme has everything so let's finalize a readme when we finish this app.

since it's your repo and I figured you have a way of doing things

nothing like that man πŸ˜… , I'm also a learner so feel free to propose any changes you wish to have πŸ˜„

So we just need a sweet CONTRIBUTING.md then.

anshumanv commented 7 years ago

Sorry, I assigned myself by mistake before πŸ˜₯

anshumanv commented 7 years ago

Okay you assigned me, nevermind I'll get this done real quick

sneakycrowllc commented 7 years ago

I don’t think anyone copied and pasted it. It generates with the CLI command.

Zachary E Sohovich Full Stack Web Developer https://sneakycr0w.com zach@sneakycr0w.com

On Oct 2, 2017, at 1:19 AM, Aditya notifications@github.com wrote:

Lol, bhai. Instead of copy pasting the entire create-react-app documentation, It would be better if we included just a link to the documentation.

β€” You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

ad-dan commented 7 years ago

My bad, I should have worded it better. The tool generates the readme but we must modify it to represent the documentation for the project instead of keeping the default one.

anshumanv commented 7 years ago

We will do so @ad-dan once the project is setup.