Making An Awesome Javascript Open Source Project

[ghost]

Code

• Linters: ESlint
• Formatter: Prettier
• Code Style: StandardJs

GitHub

• Readme. Refer Readme: What should be included? Simple list #1553

• Code Of Conduct. Recommendation: this

• Contributing.md. Include the code formatters and all guidelines

• Support.md. Refer this

• Issue Templates
  - [ ] feat.md: Feature Request
  - [ ] docs.md: Documentation Related Issue
  - [ ] fix.md: Bug Reports
  - [ ] config.yml: Add Your Chat Server/FAQ/Question Board

• Pull Request Templates
  - [ ] Use Check Marks For Indicating What All Has Been Completed
  Example:
  md - [ ] I have followed contributing Guidelines - [ ] I have followed coc - [ ] I have tested my code it doesn't break

• Security.md Tell people which versions are currently in support
  Example:
  ```md
  # Security Policy

   ## Supported Versions
   | Version | Supported |
   |------- | --------- |
   | 1.x.x   | ✅        |
  
   ## Reporting a Vulnerability
  
    To Report A Vulnerability. Mail The Author: **[[email protected]](mailto:[email protected])**
     ```
  

• CI for code ⬆️

Commits

• Husky - Lint your code automatically before git commit
• Commitlint - Check if your commits suit your commit convention
• Conventional Commits - An Amazing Commit Style @eddiejaoude's favourite

Note All Of This Is Only For Code/Docs GitHub UI (Issues, PRs, Labels, Projects...) are not included

[kaiwalyakoparkar]

Thanks for sharing ❤️

[Cahllagerfeld]

For planning and creating a large-scale JS-Project, I'd use Typescript to be honest. Thats a bit more work when setting up the project, but its more maintainable as the project grows

[ghost]

This one was just for javascript thus, typescript is not added, personally I also use ts

[ghost]

Up are the guidelines, if you have any suggestions please comment down, for now marking this as answered