CONTRIBUTING.md

Data Format

All the company data should be in a singular file companies.json. Check the data folder for example. The file will be in .json and the format of the data will be as follows (Extra fields may be added later);

{
  "companies": [
    {
      "name": "Awesome Company",
      "logoName": "awesomecompany.png",
      "establishedAt": 1667465928,
      "location": "Fully remote",
      "website": "https://anawesomewebsite.com",
      "email": "[email protected]",
      "phone": "+977-012345678",
      "socials": {
        "facebook": "https://facebook.com",
        "instagram": "https://instagram.com",
        "github": "https://github.com",
        "linkedin": "https://linkedin.com",
        "twitter": "https://twitter.com",
        "youtube": "https://youtube.com"
      }
    }
  ]
}

Contributing Guide

• Always create a relevant branch name.
• Use conventional commits whenever possible.
• Please check the correctness of data before contributing.
• Don't diverge from the format you're provided with.
• The logo for the company should be 128x128 in size and should be placed under logos/ directory of the repository.

If you encounter any issues feel free to open an issue or ping us in the Discord Server.