CONTRIBUTING.md

Contribution Guidelines

You can contribute to awesome-italia-remote with issues and PRs.

Issues

Issues can be used to ask questions, report errors, or start discussions.

Pull Requests

Pull requests can be used to add/edit/delete companies from the list.

How To Contribute with PRs

The new companies must be added to the /data folder using a dedicated file in snake_case.json format. Subsequently, the README.md file is automatically generated, so you don't have to edit it manually.

1. Open ./data directory
2. Add a new JSON file for the new company (file name should be a slugified version of the company name)
3. File content should respect the following format:

{
    "name": "CompanyName",
    "career_page_url": "https://companyname.companytld/jobs",
    "url": "https://www.companyname.companytld/",
    "remote_policy": "Full",
    "hiring_policies": [
        "Contract"
    ],
    "type": "B2B",
    "categories": [
        "cloud_software"
    ],
    "tags": [
        "PHP",
        "Go",
        "AWS"
    ]
}

Allowed Company Categories

1. cloud_software
2. design_ux
3. marketing_writing
4. hr

Allowed Company Types

1. B2B
2. B2C
3. Consulting
4. Product

Allowed Company Remote Policies

1. Full
2. Hybrid
3. Optional

Allowed Hiring Policies

1. Contract
2. Direct
3. Intermediary

Max number of tags

The maximum number of tags is 20. This rule is necessary to avoid format problems with the MarkDown file.