Come inviare le richieste pullHow to submit pull requests

Per apportare modifiche al contenuto, inviare una richiesta pull dal fork.To make changes to content, submit a pull request (PR) from your fork. Prima di eseguire il merge di una richiesta pull, è necessaria una revisione.A pull request must be reviewed before it can merged. Per ottenere risultati ottimali, esaminare l'elenco di controllo editoriale prima di inviare la richiesta pull.For best results, review the editorial checklist before submitting your pull request.

Specificare come destinazione il ramo correttoTarget the correct branch

Tutte le richieste pull devono avere come destinazione il ramo staging.All pull requests should target the staging branch. Le modifiche non devono mai essere inviate al ramo live.Changes should never be submitted to the live branch. Le modifiche apportate nel ramo staging vengono unite in live, sovrascrivendo le modifiche apportate a live.Changes made in the staging branch get merged into live, overwriting any changes made to live.

Se si sta inviando una modifica che si applica solo a una versione non rilasciata di PowerShell, cercare un ramo di rilascio per tale versione.If you are submitting a change that only applies to an unreleased version of PowerShell, check for a release branch for that version. La richiesta pull deve essere destinata al ramo di rilascio.Your PR should be targeted at the release branch. I rami di rilascio hanno il seguente modello di denominazione: release-<version>.Release branches have the following name pattern: release-<version>.

Ottimizzare il processo di richiesta pull per tuttiMake the pull request process work better for everyone

Più semplice e più mirata è la richiesta pull, più è rapida l'esecuzione della revisione e del merge.The simpler and more focused you can make your PR, the faster it can be reviewed and merged.

Evitare i rami che aggiornano un numero elevato di file o contengono modifiche non correlateAvoid branches that update large numbers of files or contain unrelated changes

Evitare di creare richieste pull contenenti modifiche non correlate.Avoid creating PRs that contain unrelated changes. Separare gli aggiornamenti secondari degli articoli esistenti dai nuovi articoli o da riscritture importanti.Separate minor updates to existing articles from new articles or major rewrites. Lavorare a queste modifiche in rami di lavoro separati.Work on these changes in separate working branches.

Le modifiche in blocco creano richieste pull con un numero elevato di file modificati.Bulk changes create PRs with large numbers of changed files. Limitare le richieste pull a un massimo di 50 file modificati.Limit your PRs to a maximum of 50 changed files. Le richieste pull di grandi dimensioni sono difficili da esaminare e più soggette a errori.Large PRs are difficult to review and are more prone to contain errors.

Ridenominazione o eliminazione di fileRenaming or deleting files

Se si rinominano o eliminano file, alla richiesta pull deve essere associato un problemaIf you are renaming or deleting files, there must be an issue associated with the PR. per cui si rende necessario rinominare o eliminare i file.That issue must discuss the need to rename or delete the files.

Evitare di mescolare aggiunte o modifiche di file a ridenominazioni ed eliminazioni.Avoid mixing content additions or change with file renames and deletes. Qualsiasi file rinominato o eliminato deve essere aggiunto al file di reindirizzamento principale.Any file that is renamed or deleted must be added to the master redirection file. Se possibile, è anche opportuno aggiornare i file collegati al contenuto rinominato o eliminato.When possible, you should also update any files that link to the renamed or deleted content. Questo riguarda anche i file di sommario.This includes any TOC files.

Servizio di convalida delle richieste pull di documentiDocs PR validation service

In GitHub è disponibile l'app Docs PR che esegue le regole di convalida sui file di una richiesta pull.The Docs PR validation service is a GitHub app that runs validation rules on the files in a PR. È necessario correggere eventuali errori o avvisi (vedere le eccezioni) segnalati dal servizio di convalida.You must fix any errors or warnings (see exceptions) reported by the validation service.

È possibile ignorare gli avvisi seguenti:The following warnings can be ignored:

Can't find service name for `<version>/<modulepath>/About/About.md`
Metadata with following name(s) are not allowed to be set in Yaml header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

Verrà visualizzato questo comportamento:You'll see the following behavior:

  1. Si invia una richiesta pull.You submit a PR.

  2. Nel commento di GitHub che indica lo stato della richiesta pull verrà visualizzato lo stato di "controllo" abilitato per il repository.In the GitHub comment that indicates the status of your PR, you'll see the status of "checks" enabled on the repository. Si noti che in questo esempio sono abilitati due controlli, "Commit Validation" e "OpenPublishing.Build":Note that in this example, there are two checks enabled, "Commit Validation" and "OpenPublishing.Build":

    stato di convalida - alcuni controlli non riusciti

    La compilazione può essere passata anche se la convalida del commit ha esito negativo.The build can pass even if commit validation fails.

  3. Per altre informazioni, vedere i dettagli.Click Details for more information.

  4. Nella pagina dei dettagli sono visualizzati tutti i controlli di convalida non riusciti, con informazioni su come risolvere i problemi.On the Details page, you'll see all the validation checks that failed, with information about how to fix the issues.

  5. Quando la convalida ha esito positivo, alla richiesta pull viene aggiunto il seguente commento:When validation succeeds, the following comment is added to the PR:

    Stato di convalida: operazione riuscita

Nota

Se si è un collaboratore esterno, non un dipendente Microsoft, non si ha accesso ai report di compilazione dettagliati o ai collegamenti all'anteprima.If you are an external (not a Microsoft employee) contributor you do not have access to the detailed build reports or preview links.

Quando la richiesta pull viene esaminata da un membro del team di PowerShell-Docs, può essere necessario apportare modifiche o risolvere i problemi contrassegnati dal report di convalida.When the PR is reviewed by a member of the PowerShell-Docs team, you may be asked to make changes or fix problems flagged by the validation report. Il team di PowerShell-Docs può aiutare l'utente a capire come correggere ed evitare questi problemi negli invii futuri.The PowerShell-Docs team can help you understand how to fix and avoid these problems for future submissions.

Passaggi successiviNext steps

Guida di stile per la documentazione di PowerShellPowerShell-Docs style guide

Risorse aggiuntiveAdditional resources

Modalità di gestione delle richieste pullHow we manage pull requests