Skip to content

Latest commit

 

History

34 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CONTRIBUTING.md (contributing-md)

About this repository

This is not our API. This repository is an independent, third-party profile of a company's publicly available API surface, maintained by API Evangelist. API Evangelist does not operate, host, resell, or support this company's APIs, and is not affiliated with or endorsed by the company unless stated on the profile.

Where the information came from. Everything here is assembled from material a member of the public can reach with a browser and no credentials — the company's own website, developer portal and documentation, the specifications it publishes for public use (OpenAPI, AsyncAPI, JSON Schema, apis.json, llms.txt and similar), its public repositories, and its public status, pricing and changelog pages. Nothing here is obtained by breaching a system, defeating an access control, or using credentials of any kind.

The rating is an independent assessment. The Kin Score and Agent Readiness rating are independently calculated scores of a company's public API artifacts, produced by API Evangelist against a published rubric. They are not certifications, endorsements, security assessments, or audits, and they score published artifacts — not the quality, safety, or security of the software.

Corrections, re-scores, and removal are free. No partnership, contract, or purchase is required, and you do not need to justify the request.

  • Something wrong? Open an issue on this repository, or email info@apievangelist.com.
  • Published something new? Ask for a re-score and we will re-run the rating.
  • Want the listing taken down? Say so and we will honor it. The profile is reduced to your company name, a factual description, and a link to your own site, and the company is recorded as unrated — never scored zero for having asked.

Response times. Acknowledgement within one business day; removal or restriction within two business days; corrections and re-scores within five business days.

Not from the company, and here with a question? You are welcome here — we would rather be the front line and point you the right way than have a good report go nowhere. What this repository can answer is narrow, though, so it is worth knowing who you are actually looking for:

  • A question about how the API works, an account, billing, or a bug in the service — that is the company's own support, not us. We profile this API; we do not operate it and cannot see your account.
  • A bug in an open-source project we only catalog — file it on that project's own repository. This has happened with a real and correct bug report that reached us instead of the people who could fix it, which helped nobody.
  • Anything about this listing itself — the description, the tags, the rating, a missing or wrong artifact — is ours. Open an issue here.
  • Not sure, or something general about API Evangelist or APIs.io — open an issue on the APIs.io Inbox and we will route it.

This repository contains no software, and we will never ask you to download anything. There is no build, release, installer, or binary here — only text and machine-readable API descriptions, so there is nothing here that can be "corrupt" or need "repairing". Any issue, comment, or email claiming otherwise and offering a download link is not from us and is hostile. Do not follow the link; it is a lure. Report it to GitHub and, if you like, tell us at info@apievangelist.com so we can take it down.

On a security or compliance team? Email info@apievangelist.com with security in the subject line and you will get a person, not a form. We will tell you exactly which public URLs this profile was built from so your team can see the same surface we did, and we will take the listing down on request while you work through it.

Full detail: Where this data comes from

CONTRIBUTING.md is a community health convention used by open source projects on GitHub and other platforms to document how external contributors can participate. The file communicates contribution guidelines, pull request processes, issue reporting procedures, coding standards, development setup, testing expectations, and code of conduct references. GitHub recognizes CONTRIBUTING.md placed in the repository root, the .github folder, or the docs folder, and surfaces a link to it whenever a contributor opens a new issue or pull request.

URL: Visit APIs.json URL

Type

  • x-type: standard

Tags:

  • Code Of Conduct, Collaboration, Community Health, Developer Guidelines, Documentation, GitHub, Markdown, Open Source, Pull Requests, Repository

Timestamps

  • Created: 2025-01-01
  • Modified: 2026-04-28

APIs

CONTRIBUTING.md Format

The CONTRIBUTING.md format is an unstructured Markdown convention that documents how to contribute to a project. GitHub recognizes the file in three locations checked in priority order: the .github folder, the repository root, and the docs folder. When a contributor opens an issue or pull request, GitHub automatically links to the file. Typical sections include contribution workflow, development setup, branch and commit conventions, code style, testing, pull request review process, code of conduct reference, and licensing terms.

Human URL: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Tags:

  • Community Health, Convention, Documentation, Markdown

Properties

Features

  • Triggers contribution prompt on new issues and pull requests
  • Recognized by GitHub, GitLab, Bitbucket, and Gitea
  • Pairs with CODE_OF_CONDUCT.md, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE
  • Can live in repository root, .github, or docs directory
  • Often references a Developer Certificate of Origin or CLA process

Use Cases

  • Onboarding first-time contributors to an open source project
  • Documenting fork-and-pull workflow expectations
  • Defining branch naming, commit message, and review conventions
  • Specifying local development setup and required toolchains
  • Linking to community resources such as Discord, mailing lists, or forums

CONTRIBUTING.md Related Conventions

CONTRIBUTING.md is one of several community health files GitHub looks for when scoring a repository community profile. Sibling files include README.md, LICENSE, CODE_OF_CONDUCT.md, SECURITY.md, SUPPORT.md, and issue and pull request templates. Together these conventions establish a well-formed, welcoming open source project that lowers the barrier for new contributors.

Human URL: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions

Tags:

  • Community Health, Convention, GitHub, Open Source

Properties

Features

  • Recognized as part of the GitHub community profile checklist
  • Composable with CODE_OF_CONDUCT.md, SECURITY.md, and SUPPORT.md
  • Compatible with All Contributors specification for recognition
  • Often pairs with .github/ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE.md

Use Cases

  • Completing the GitHub community profile health checklist
  • Defining the entire community health surface for an organization
  • Standardizing contribution conventions across many repositories

Common Properties

Maintainers

FN: Kin Lane

Email: kin@apievangelist.com

About

CONTRIBUTING.md — independent third-party profile of a public API surface, by API Evangelist. CONTRIBUTING.md is a community health convention used by open source projects on GitHub and other platforms to document how external contributors can participate. The file communicates contribution guidelines, pull request processes, issue reporting proced

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors