gptkrsh / username-checker Goto Github PK

You have to add this COC:

• Example File in Another repo - Contributor Covenant Code of Conduct v2

Use the create next CLI App, and generate a boilerplate

• Should be typescript
• Add metadata to the package-lock file
• Add an src folder for better dir management: https://nextjs.org/docs/advanced-features/src-directory

Add the following actions:

• CI & CD
• Stale
• Changelog Release

Project Base

I like new contributors to set up these applications because I already have done many, plus will help new contributors get a hand on Open Source

• NextJS: Use the create next CLI App, and generate a boiler plate: #2
• TailwindCSS: Setup TailwindCSS with Sass #3

Open Source Best Practices

For these, I generally just use the same files everywhere (for consistency), you can have a look at these, and add these files

• Code Of Conduct - Contributor Covenant Code of Conduct v2: #4
• Contributing Guide - Contributing guide template: #5
• License - MIT License : #6
• Security Policy - Informs users on how to report vulnerabilities : #6
• Issue Templates - Basic Issue Templates: #7
• PR Template - Fallback PR Template: #7

Automation

For automation, I don't really use much, but CI/CD, Stale and Changelog Release help automate common tasks

• CI & CD: #8
• Stale: #8
• Changelog Release: #8

Gitpodify

You can have a read at https://www.gitpod.io/blog/gitpodify/ and gitpodify this project, feel free to ask for any help: #9

You can have a read at https://www.gitpod.io/blog/gitpodify/ and gitpodify this project, feel free to ask for any help

Addition of TailwindCSS & Sass

• Follow this guide for Tailwind: https://tailwindcss.com/docs/guides/nextjs
• You can refer this for Sass: https://nextjs.org/docs/basic-features/built-in-css-support#sass-support

Happy Hacking :)

Add the following:

• Issue Templates - Basic Issue Templates
• PR Template - Fallback PR Template

Add the following:

• License - MIT License
• Security Policy - Informs users on how to report vulnerabilities

You can copy this contributing guide and just check if all the links work, may need a few changes because this is not on the same ORG (Links might be broken 😬)