Een pull request voorstellen
Pull requests zijn welkom, van een typfout tot een nieuwe tool. Deze pagina is het pad om te volgen; Ontwikkeling beschrijft de repository en zijn controles in detail. Je hebt een GitHub-account nodig, git, uv en just.
Stap voor stap
Section titled “Stap voor stap”-
Forken en klonen. Klik op GitHub op Fork en kloon vervolgens uw kopie. Met de GitHub CLI, in één opdracht:
Terminal window gh repo fork mathbeal/avenir-mcp --clonecd avenir-mcp -
Installeren en het vertrekpunt controleren.
Terminal window uv sync # Python 3.15 en de vastgelegde ontwikkeltoolsjust check # alles moet slagen voordat u iets verandert -
Maak een branch met de naam van de wijziging:
Terminal window git switch -c feat/subscription-increases -
Schrijf eerst de test, kijk hoe deze mislukt en schrijf vervolgens de code waarmee de test slaagt. Tests maken uitsluitend gebruik van verzonnen gegevens — nooit YNAB, nooit uw plan. Voeg gegevens toe aan het demoplan indien
evals/demo_budget.pyeen voorbeeld nieuwe cijfers vereist. -
Draai de controles tot ze allemaal slagen:
Terminal window just fix # opmaakjust check # ruff, pylint, mypy, pytest (100 % dekking), woordenschat, lockjust hygiene # typos, controle van de workflows, licenties (REUSE)just secrets # gitleaks op elke commit (vraagt Docker) -
Werk de documentatie bij. Als een tool, de argumenten ervan of de resultaten zijn gewijzigd, voer
uv run python -m docsgende tool dan uit en leg de gegenereerde tekst vast. Een handmatig geschreven pagina wordt in alle talen van de website tegelijk gewijzigd; de website wordt opnieuwjust docsopgebouwd en er treedt een fout op bij een gebroken link. -
Commit met een voorvoegsel dat het soort wijziging noemt – de changelog wordt eruit gegenereerd:
Terminal window git commit -s -m "feat: list subscriptions whose price went up"-sondertekent de commit: u verklaart dat u in het bezit bent van het Ontwikkelaarscertificaat van herkomst — u hebt de wijziging geschreven of beschikt over het recht om deze in te dienen onder de MIT-licentie. -
Pushen en het pull request openen.
Terminal window git push -u origin feat/subscription-increasesgh pr create --fillOf open het via de link die GitHub toont. Vul het sjabloon in: wat en waarom, hoe het is gecontroleerd, de checklist, en
Closes #<issue>.
Wat er daarna gebeurt
Section titled “Wat er daarna gebeurt”| Fase | Wat u kunt verwachten |
|---|---|
| CI | dezelfde controles als just checken just hygiene, op Linux, macOS en Windows, de documentatiebouw, de MCP Inspector, goedgekeurde commits en een titel die begint met het soort wijziging; CI geslaagd en MCP Inspector moeten groen zijn. Bij een eerste bijdrage keurt een beheerder de run eerst goed. |
| Beoordeling | opmerkingen over de code; push nieuwe commits naar dezelfde branch om hierop te reageren |
| Samenvoegen | samengevoegd tot één commit op main, met de titel van uw pull-verzoek als bericht |
| Uitgave | uw wijziging verschijnt in het wijzigingslogboek |
Wat een pull request mergeklaar maakt
Section titled “Wat een pull request mergeklaar maakt”- Eén wijziging per pull request, klein genoeg om in één keer te beoordelen.
- Eerst tests geschreven, die elke regel en vertakking dekken.
- Geen nieuwe runtime-afhankelijkheid zonder een reden in het pull request.
- Schrijfacties blijven veilig: een tool die het plan wijzigt, toont een voorbeeld, wacht op bevestiging en kan ongedaan worden gemaakt – zie Veilig door ontwerp.
- Geen echte financiële gegevens, nergens: code, tests, documentatie, schermafbeeldingen.
- Elke commit afgetekend (
git commit -s).
Het volledige contract staat in AGENTS.md, dat geldt voor mensen en codeeragents.
Onofficieel project. “We are not affiliated, associated, or in any way officially connected with YNAB or any of its subsidiaries or affiliates. The official YNAB website can be found at https://www.ynab.com. The names YNAB and You Need A Budget, as well as related names, tradenames, marks, trademarks, emblems, and images are registered trademarks of YNAB.” We zijn op geen enkele manier verbonden, geassocieerd of officieel gelieerd aan YNAB of een van zijn dochterondernemingen of gelieerde bedrijven. De officiële website van YNAB vind je op https://www.ynab.com. De namen YNAB en You Need A Budget, evenals verwante namen, handelsnamen, merken, emblemen en afbeeldingen, zijn geregistreerde handelsmerken van YNAB. avenir-mcp wordt geleverd zoals het is, zonder garantie, en is geen financieel advies. Juridische informatie · Privacy