Skip to content

docs:create VISION.md with project overview and goals#865

Draft
dinalivia wants to merge 1 commit intomainfrom
864
Draft

docs:create VISION.md with project overview and goals#865
dinalivia wants to merge 1 commit intomainfrom
864

Conversation

@dinalivia
Copy link
Copy Markdown
Contributor

@dinalivia dinalivia commented Feb 27, 2026

Added a comprehensive VISION.md document outlining the project's mission, purpose, future vision, and target audience.

Description

Motivation behind this PR?

What type of change is this?

Checklist

  • A changelog entry was added, or this PR does not require one. Instructions
  • Unit tests were added or updated as needed, or not required for this change. Instructions
  • All unit tests pass locally. Instructions
  • Docstrings or comments were added or updated as needed, or no documentation changes were required. Instructions
  • This PR does not significantly reduce code or docstring coverage.
  • Code follows the project’s style guidelines.
  • ScanAPI was run locally and the changes were manually verified, or this was not necessary. Instructions

Issue

Closes #<issue_number>

@dinalivia
Create VISION.md with project overview and goals
e79c7ca 
Added a comprehensive VISION.md document outlining the project's mission, purpose, future vision, and target audience.
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.98%. Comparing base (422c79c) to head (e79c7ca).
⚠️ Report is 73 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #865      +/-   ##
==========================================
+ Coverage   97.96%   97.98%   +0.01%     
==========================================
  Files          24       24              
  Lines         787      842      +55     
==========================================
+ Hits          771      825      +54     
- Misses         16       17       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@camilamaia camilamaia changed the title Create VISION.md with project overview and goals docs: create VISION.md with project overview and goals Apr 11, 2026
@antoniamaia antoniamaia changed the title docs: create VISION.md with project overview and goals create VISION.md with project overview and goals Apr 16, 2026
@antoniamaia antoniamaia marked this pull request as ready for review April 16, 2026 07:05
@antoniamaia antoniamaia requested review from a team as code owners April 16, 2026 07:05
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 16, 2026 •
edited
Loading

📌 Esta mensagem está tanto em português quanto em inglês (mais abaixo) — assim todo mundo consegue acompanhar!
📌 This message is in both Portuguese and English (further down) — so everyone can follow along!

🇧🇷 Português

Oi! Muito obrigada por abrir esse pull request 💜

Por aqui, seguimos o padrão do Conventional Commits para os títulos das PRs.
Esse padrão ajuda a manter o histórico do projeto organizado e claro.

No seu caso, o título do PR precisa de um pequeno ajuste pra ficar dentro desse formato. Isso é super comum no começo, então suaveee!

👉 Um título válido geralmente começa com um prefixo como:

  • build: para mudanças no sistema de build ou dependências externas
  • chore: para tarefas de manutenção
  • ci: para integrações contínuas
  • docs: para mudanças na documentação
  • feat: para novas funcionalidades
  • fix: para correções de bugs
  • perf: para melhorias de performance
  • refactor: para melhorias internas no código
  • revert: para reverter um commit anterior
  • style: para mudanças de formatação
  • test: para adição ou ajustes de testes

Exemplos de títulos que adoraríamos ver por aqui:

prefixo: mensagem descritiva

feat: permitir que o objeto de configuração fornecido estenda outras configurações

fix: corrige pequenos erros de digitação no código

Esses são só alguns exemplos — a documentação oficial tem mais opções e explicações.

Antes de seguir com o PR, dá uma olhadinha lá pra entender bem o padrão — isso vai te ajudar bastante nesta e em futuras contribuições também.

O título atual está assim (fora do padrão esperado):

No release type found in pull request title "docs:create VISION.md with project overview and goals". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - build
 - chore
 - ci
 - docs
 - feat
 - fix
 - perf
 - refactor
 - revert
 - style
 - test

Qualquer dúvida, é só chamar por aqui! Estamos aqui para te ajudar!

🇬🇧 English

Hey there and thank you for opening this pull request! 💜

In this project, we follow the Conventional Commits specification for PR titles.
This helps keep the commit history organized and clean.

In your case, the PR title needs a small adjustment to match the expected format. Totally normal if this is your first time — no stress!

👉 A valid PR title usually starts with a prefix like:

  • build: for build system or external dependency changes
  • chore: for maintenance tasks
  • ci: for continuous integration changes
  • docs: for documentation updates
  • feat: for new features
  • fix: for bug fixes
  • perf: for performance improvements
  • refactor: for internal code improvements
  • revert: for reverting a previous commit
  • style: for formatting changes
  • test: for test additions or changes

Examples of titles we'd love to see here:

prefix: descriptive message

feat: allow the provided config object to extend other configurations

fix: correct minor typos in the code

These are just a few examples — the official documentation has more options and great explanations.
Before continuing with the PR, we recommend reading it — it'll really help with this and future contributions.

💡 Here's the current title (which doesn't follow the expected format):

No release type found in pull request title "docs:create VISION.md with project overview and goals". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - build
 - chore
 - ci
 - docs
 - feat
 - fix
 - perf
 - refactor
 - revert
 - style
 - test

Let us know if you need help updating it — we’re here to support you!

@antoniamaia antoniamaia changed the title create VISION.md with project overview and goals docs:create VISION.md with project overview and goals Apr 16, 2026
@antoniamaia antoniamaia marked this pull request as draft April 16, 2026 07:06
@antoniamaia
Copy link
Copy Markdown
Member

antoniamaia commented Apr 16, 2026

@dinalivia just taking some screenshots for ScanAPI presentation :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dinalivia @antoniamaia