CONTRIBUTING.md added

[priyanshnama]

I have added CONTRIBUTING.md file to help people in sending pull request and contribute to this.
#3
Do Suggest changes if any.

[priyanshnama]

@garg3133 tried adding this line to template.md

Wants to add new repo in the list checkout CONTRIBUTING.md for the same

but i doubt this would be picked up by python file as i have added it in end.
I have not included this change in the pr as of now.

[garg3133]

@priyanshnama How about splitting the template into two files? template-top.md and template-bottom.md.

[garg3133]

I think if they are adding a new repo to this list, opening an issue won't make sense.

They should only open issues if they are proposing something new. So, we can make a new section for this something like Want to propose something?

[priyanshnama]

actually i added that in general sense, if any person encounters any flaws or wants a feature.

[garg3133]

But it sounds more like they need to open an issue everytime they want to add something, even while adding a new repository.

Feel free to open an issue if you have something new to propose or something similar will sound better.

[priyanshnama]

yes... this should be done.. i am pushing a commit for the same

[garg3133]

Also, fix the typo here.

[priyanshnama]

sorry for this typo, i shall fix this

[priyanshnama]

@priyanshnama How about splitting the template into two files? template-top.md and template-bottom.md.

@garg3133 then why to create a new file template-bottom.md
we can hardcode the markdown text in python file as a string and use it - as it is just one line of code.
because we will have to bring changes in python file in both ways.

[garg3133]

@priyanshnama And how about deprecating the use of template.md also and bringing all the content from json file itself?

[garg3133]

Also, I'm thinking of putting repositories in Categories. Any idea how should we make those categories? Like difficulty-wise or language-wise..

[priyanshnama]

@priyanshnama And how about deprecating the use of template.md also and bringing all the content from json file itself?

@garg3133 i don't think we should do that.

I fear it would increase cognitive complexity of python code.
Moreover, a sperate file makes us understand how the structure of readme would be - using only python code won't.
The functionality of python code is really understandable as of now.
Moreover, making any change in structure of readme would be very easy till we use template.md

[priyanshnama]

Also, I'm thinking of putting repositories in Categories. Any idea how should we make those categories? Like difficulty-wise or language-wise..

@garg3133 yup. we can do this.
I think we should do this language wise.