useWeb3 icon indicating copy to clipboard operation
useWeb3 copied to clipboard

Create standard Github templates for Issues (adding content)

Open wslyvh opened this issue 3 years ago • 3 comments
trafficstars

Since all content has moved to the repo itself, it's a little bit more work to keep tags/languages up to date. A Github Issue template could help standardize

wslyvh avatar Feb 11 '22 09:02 wslyvh

@wslyvh do you want it in yaml format?

RishiKumarRay avatar Feb 11 '22 11:02 RishiKumarRay

Hi @RishiKumarRay, that's for picking this up! If I'm correct, it can be in markdown or yaml? Either would be fine.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates I think a PR template would make most sense.

Some information and guidelines that should be included in the template:

  1. Resources should be submitted in markdown format in their respective sub folders in /content

  2. The following properties can be used

  title: string
  description: string
  content: string
  authors: Array<string>
  date?: Date
  level: 'All' | 'Beginner' | 'Intermediate' | 'Advanced'
  tags: Array<string>
  languages: Array<string>
  url: string
  alternateUrl?: string
  dateAdded: Date 
  1. The filename should be a 'slugified' version of the title

  2. Date formats should be in: YYYY-MM-DD

  3. Properties with a ? are optional

  4. The following tags are allowed. Don't use any other tags. If you feel like something is missing, please create a separate issue/PR Smart Contracts, Dapp, Web3, DeFi, Security, EVM, DevEx, Cryptography, UX & Design, Tokens, DAO, Storage, IPFS, NFT, IDE, Privacy, Architecture, Scalability, Mobile

  5. The following languages are currently used. Feel free to add new languages, but only submit actual programming languages (not protocols or other tags) Solidity, Rust, Cairo, JavaScript, Vyper, Python

Thank you! 🙏

wslyvh avatar Feb 22 '22 08:02 wslyvh

I think it should be added on the content/tutorials page so it's easier to find

thirtyninetythree avatar Sep 16 '22 08:09 thirtyninetythree

Closed with #102

wslyvh avatar Apr 15 '23 10:04 wslyvh