Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template for .md file #6

Open
ashishk1331 opened this issue Oct 1, 2023 · 1 comment
Open

Template for .md file #6

ashishk1331 opened this issue Oct 1, 2023 · 1 comment
Assignees

Comments

@ashishk1331
Copy link
Contributor

ashishk1331 commented Oct 1, 2023

We can provide a pre-made template for how one's .md file should look like.

---
title: lorem
description: description about lorem
link: to the projects source code and deployment(if available)
tech_stack: [array, of, tags] 
github_profile_link: url to the github profile
---

Moreover, constraint the data to Yaml front matter format.
This way people can simply duplicate the file and make changes into it. This will ensure uniformity across md files and make it easier to check for bad PRs.

Step involved:

  • Create template.md file
  • update README.md accordingly

Additional bifurcation:
We can even divide the projects I to three folders respectively like you mentioned in the README.

I would love to make the changes and contribute to the project. If you like the proposal, consider assigning me to the issue.

@kanha-gupta
Copy link
Owner

@ashishk1331 Sure, Instead of creating a seperate template.md file, display the structure in readme file itself. and Regarding additional bifurcation, We will perform a structure refactor once we get enough projects.
Thank you

ashishk1331 added a commit to ashishk1331/Projects-showcase that referenced this issue Oct 2, 2023
ashishk1331 added a commit to ashishk1331/Projects-showcase that referenced this issue Oct 2, 2023
kanha-gupta pushed a commit that referenced this issue Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants