Bekräftelse av kod

Detta avsnitt riktar sig till sammanslagningarna och till alla som är intresserade av att veta hur kod läggs in i Django. Om du är en medlem i samhället som vill bidra med kod till Django, titta på Arbeta med Git och GitHub istället.

Hantering av pull requests

Eftersom Django är värd på GitHub tillhandahålls korrigeringar i form av pull requests.

När du bekräftar en pull request ska du se till att varje enskild bekräftelse överensstämmer med de riktlinjer för bekräftelse som beskrivs nedan. Bidragsgivare förväntas tillhandahålla så bra pull requests som möjligt. I praktiken kan sammanslagningar - som sannolikt kommer att vara mer bekanta med riktlinjerna för commit - besluta att själva uppdatera en commit till standard.

Du kanske vill låta Jenkins eller GitHub testa pull request med någon av de pull request-byggare som inte körs automatiskt, t.ex. Oracle eller Selenium. Se CI wiki-sidan för instruktioner.

Om du tycker att du oftare kollar in pull requests lokalt kommer detta git-alias att vara till hjälp:

[alias]
    pr = !sh -c \"git fetch upstream pull/${1}/head:pr/${1} && git checkout pr/${1}\"

Lägg till det i din ~/.gitconfig, och ställ in upstream till att vara django/django. Sedan kan du köra git pr #### för att checka ut motsvarande pull request.

Vid det här laget kan du arbeta med koden. Använd git rebase -i och git commit --amend för att se till att commitarna har den förväntade kvalitetsnivån. När du är redo:

Linux/macOS

$ # Pull in the latest changes from main.
$ git checkout main
$ git pull upstream main
$ # Rebase the pull request on main.
$ git checkout pr/####
$ git rebase main
$ git checkout main
$ # Merge the work as "fast-forward" to main to avoid a merge commit.
$ # (in practice, you can omit "--ff-only" since you just rebased)
$ git merge --ff-only pr/XXXX
$ # If you're not sure if you did things correctly, check that only the
$ # changes you expect will be pushed to upstream.
$ git push --dry-run upstream main
$ # Push!
$ git push upstream main
$ # Delete the pull request branch.
$ git branch -d pr/xxxx

Windows

...\> REM Pull in the latest changes from main.
...\> git checkout main
...\> git pull upstream main
...\> REM Rebase the pull request on main.
...\> git checkout pr/####
...\> git rebase main
...\> git checkout main
...\> REM Merge the work as "fast-forward" to main to avoid a merge commit.
...\> REM (in practice, you can omit "--ff-only" since you just rebased)
...\> git merge --ff-only pr/XXXX
...\> REM If you're not sure if you did things correctly, check that only the
...\> REM changes you expect will be pushed to upstream.
...\> git push --dry-run upstream main
...\> REM Push!
...\> git push upstream main
...\> REM Delete the pull request branch.
...\> git branch -d pr/xxxx

Tvinga fram en push till grenen efter ombasering på main men innan sammanslagning och push till upstream. Detta gör att commit-hasharna på main och grenen matchar varandra, vilket automatiskt stänger pull-begäran.

Om en pull request inte behöver slås samman som flera commits kan du använda GitHubs ”Squash and merge”-knapp på webbplatsen. Redigera commit-meddelandet efter behov så att det överensstämmer med riktlinjerna och ta bort pull request-numret som automatiskt läggs till på meddelandets första rad.

När man skriver om commit-historiken för en pull-begäran är målet att göra Djangos commit-historik så användbar som möjligt:

• Om en patch innehåller fram-och-tillbaka-kommits, skriv då om dem till en. Om till exempel en commit lägger till lite kod och en andra commit åtgärdar stilistiska problem som introducerades i den första commiten, bör dessa commits krossas innan de slås samman.

• Separera ändringar till olika commits genom logisk gruppering: om du gör en stilistisk upprensning samtidigt som du gör andra ändringar i en fil blir det lättare att granska historiken om du separerar ändringarna i två olika commits.

• Akta dig för sammanslagningar av uppströmsgrenar i pull requests.

• Tester ska godkännas och dokument ska byggas efter varje commit. Varken testerna eller dokumenten ska ge upphov till varningar.

• Triviala och små korrigeringar görs oftast bäst i en commit. Medelstort till stort arbete kan delas upp i flera commits om det är meningsfullt.

Praktikalitet slår renhet, så det är upp till varje sammanslagning att bestämma hur mycket historikmangling som ska göras för en pull-begäran. Huvudpunkterna är att engagera samhället, få arbetet gjort och ha en användbar commit-historik.

Riktlinjer för åtaganden

Dessutom ber vi dig följa följande riktlinjer när du överför kod till Djangos Git-arkiv:

• Ändra aldrig den publicerade historiken för django/django grenar genom force pushing. Om du absolut måste (t.ex. av säkerhetsskäl), diskutera först situationen med teamet.

• För alla medelstora till stora ändringar, där ”medelstora till stora” är enligt din bedömning, ta upp saker på Django Forum innan du gör ändringen.

  Om du tar upp något och ingen svarar, ta inte det som att din idé är fantastisk och bör genomföras omedelbart eftersom ingen ifrågasatte den. Alla har inte alltid så mycket tid att läsa diskussioner direkt, så du kanske måste vänta ett par dagar innan du får ett svar.

• Skriv detaljerade meddelanden om åtaganden i förfluten tid, inte i nutid.

  • Bra: ”Fixat Unicode-buggen i RSS API.”

  • Dåligt: ”Åtgärdar Unicode-buggen i RSS API.”

  • Dåligt: ”Åtgärdar Unicode-bugg i RSS API.”

  Meddelandet ska bestå av rader om högst 72 tecken. Det ska finnas en ämnesrad, åtskild av en blankrad och sedan stycken med 72 teckenrader. Gränserna är mjuka. För ämnesraden gäller att kortare är bättre. I brödtexten i meddelandet är mer detaljer bättre än mindre:

  Fixed #18307 -- Added git workflow guidelines.
  
  Refactored the Django's documentation to remove mentions of SVN
  specific tasks. Added guidelines of how to use Git, GitHub, and
  how to use pull request together with Trac instead.
  

  Kreditera bidragsgivarna i commit-meddelandet: ”Tack A för rapporten och B för granskningen.” Använd git’s Co-Authored-By på lämpligt sätt.

• För överföringar till en gren ska du ange grenens namn som prefix i överföringsmeddelandet. Till exempel ”[1.4.x] Fixat #xxxxx – Lagt till stöd för tankeläsning.”

• Begränsa commits till den mest detaljerade förändring som är meningsfull. Detta innebär att du bör använda frekventa små commits snarare än sällan förekommande stora commits. Om det till exempel krävs en liten ändring i bibliotek Y för att implementera funktion X, ska du först göra ändringen i bibliotek Y och sedan göra funktion X i en separat commit. Detta hjälper långt på vägen för att hjälpa alla att följa dina ändringar.

• Separera buggfixar från funktionsändringar. Buggfixar kan behöva backporteras till den stabila grenen, enligt Versioner som stöds.

• Om din commit stänger ett ärende i Djangos ticket tracker ska du börja ditt commit-meddelande med texten ”Fixed #xxxxx”, där ”xxxxx” är numret på ärendet som din commit åtgärdar. Exempel: ”Fixat #123 – Lagt till whizbang-funktion.”. Vi har riggat Trac så att alla commit-meddelanden i det formatet automatiskt stänger det refererade ärendet och lägger upp en kommentar till det med hela commit-meddelandet.

  För den nyfikne kan vi berätta att vi använder ett ”Trac-plugin” för detta.

Observera

Observera att Trac-integrationen inte vet något om pull-förfrågningar. Så om du försöker stänga en pull request med frasen ”closes #400” i ditt commit-meddelande, kommer GitHub att stänga pull request, men Trac-pluginet kommer inte att stänga samma numrerade ärende i Trac.

• Om din commit refererar till ett ärende i Djangos ticket tracker men inte stänger ärendet, inkludera frasen ”Refs #xxxxx”, där ”xxxxx” är numret på ärendet som din commit refererar till. Detta kommer automatiskt att skicka en kommentar till lämplig biljett.

• Skriv commit-meddelanden för backports med hjälp av detta mönster:

  [<Django version>] Fixed <ticket> -- <description>
  
  Backport of <revision> from <branch>.
  

  Till exempel:

  [1.3.x] Fixed #17028 -- Changed diveintopython.org -> diveintopython.net.
  
  Backport of 80c0cbf1c97047daed2c5b41b296bbc56fe1d7e3 from main.
  

  Det finns ett skript på wikin för att automatisera detta.

  Om överföringen åtgärdar en regression, inkludera detta i överföringsmeddelandet:

  Regression in 6ecccad711b52f9273b1acb07a57d3f806e93928.
  

  (använd den commit-hash där regressionen introducerades).

Återställning av ändringar

Ingen är perfekt; misstag kommer att begås.

Men vi gör vårt yttersta för att se till att misstag inte sker. Bara för att vi har en återföringspolicy minskar inte ditt ansvar för att sträva efter högsta möjliga kvalitet. Verkligen: dubbelkolla ditt arbete, eller få det kontrollerat av en annan merger innan du överhuvudtaget skickar in det!

När ett felaktigt åtagande upptäcks ska du följa dessa riktlinjer:

• Om möjligt, låt den ursprungliga författaren återställa sin egen commit.

• Återställ inte en annan författares ändringar utan tillstånd från den ursprungliga författaren.

• Använd git revert – detta kommer att göra en omvänd commit, men den ursprungliga commiten kommer fortfarande att vara en del av commit-historiken.

• Om den ursprungliga författaren inte kan nås (inom rimlig tid - en dag eller så) och problemet är allvarligt - kraschande bugg, stora testfel, etc. – be då om invändningar på Django Forum och återställ sedan om det inte finns några.

• Om problemet är litet (t.ex. en funktion efter en annan) kan du vänta ut det.

• Om det finns en oenighet mellan sammanslagningen och den blivande omvändaren, försök då att lösa det på Django Forum . Om en överenskommelse inte kan nås bör det läggas till en omröstning.

• Om commit introducerade en bekräftad, offentliggjord säkerhetsbrist kan commit omedelbart återkallas utan tillstånd från någon.

• Underhållaren för releasegrenen kan utan tillstånd backa upp överföringar till releasegrenen om överföringen bryter releasegrenen.

• Om du av misstag flyttar en ämnesgren till django/django ska du ta bort den. Till exempel, om du gjorde: git push upstream feature_antigravity, gör en omvänd push: git push upstream :feature_antigravity.