Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (53 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.94 KB

Contributing to Awesome ScanAPI

Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts!

This repository is a curated list of real-world projects that use ScanAPI. The goal is to showcase practical use cases, not just examples or demos.

What can be added?

You can contribute with:

  • Real-world projects using ScanAPI
  • Open source tools, libraries or templates
  • Case studies, blog posts or talks
  • Production or side projects

What should NOT be added?

Please avoid:

  • Toy examples or hello-world projects
  • Projects that do not actually use ScanAPI
  • Generic API testing tools (not based on ScanAPI)
  • Marketing-only links without technical content

This is not a list of "API tools", it's a list of projects that use ScanAPI.

How the list is organized

Domains (main categories)

Each project belongs to one domain, based on the type of API:

Examples:

  • Payments & Banking
  • E-commerce & Marketplaces
  • Public Sector & Open Data
  • Developer Platforms
  • Data Providers
  • Cloud & Infrastructure
  • Security & Identity
  • Social & Community

Choose the domain that best represents the business context of the API.

Purpose tags

Each project can have multiple tags, describing how ScanAPI is used.

Common tags:

  • #monitoring
  • #data-validation
  • #regression
  • #integration
  • #ci-cd
  • #observability
  • #public-data

Tags represent use cases, not technical stack.

You can suggest new tags if needed.

How to add a project

  1. Fork this repository.
  2. Add your project to the appropriate domain section in README.md.
  3. Use the following format:
- **Project Name** – short description of the project
  `#tag1 #tag2 #tag3`

As one of the repositories under the scanapi GitHub organization, this repository follows the ScanAPI Contributing Guideline.