QForestCommunity / launchpad

Resources to get started in Quantum Computing!
MIT License
37 stars 16 forks source link

[FEATURE REQ] Standardize format of resources #13

Open MadhavJivrajani opened 4 years ago

MadhavJivrajani commented 4 years ago

Is your feature request related to a problem? Please describe. Need to standardize the way resources are submitted, the resources available aren't uniform in terms of they way they are presented.

Describe the solution you'd like Things like what the file should be named, what the title should be, should a link come first followed by a description or the other way round, a pre-requisite section is required or not need to be agreed upon.

Describe alternatives you've considered (if any) None

Additional context None

MadhavJivrajani commented 4 years ago

Here are a few things that we should maintain uniformly across resources:

After discussion, we can come up with a guideline for the same that should be followed. Let me know what your thoughts on this are.

SashwatAnagolum commented 4 years ago

Sounds good. Will update the QML folder, as well as the tutorial guidelines file to reflect this.

MadhavJivrajani commented 4 years ago

Let's create a file called CONTRIBUTING.md and put guidelines for tutorials and resources under separate sections in that?

MadhavJivrajani commented 4 years ago

Due to inactivity, I'm assuming you agree with whatever is mentioned above. @Sashe17 @SashwatAnagolum @mugdhapattnaik please change your resource files accordingly and send in a PR at the earliest.

MadhavJivrajani commented 4 years ago

Any update?