launchpad
launchpad copied to clipboard
QForestCommunity
[FEATURE REQ] Standardize format of resources
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
Here are a few things that we should maintain uniformly across resources:
- The file name for the resource should be
README.mdand not anything else. Doing so would make more sense since when someone clicks on a folder for resources, a file namedREADME.mdis automatically displayed, this won't happen if the name is something else like in the QML folder. - Most online repositories (ex) dedicated for curating resources follow the pattern:
Link to resource: Description of resource(description in the same line as the resource). The name that is given to the link is the title of the article/paper or the name of the video or if none of them apply, it should be a short name describing clearly what this resource entails and more description about the resource can be provided in the description of the resource. - We don't have a lot of resources per area as of now, but as and when we do, we can create sections for MOOCs, papers, websites, etc as done in the above-mentioned link.
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.
Sounds good. Will update the QML folder, as well as the tutorial guidelines file to reflect this.
Let's create a file called CONTRIBUTING.md and put guidelines for tutorials and resources under separate sections in that?
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.