Panoramica della guida per i collaboratori di Microsoft DocsMicrosoft Docs contributor guide overview

Questa è la Guida per i collaboratori di docs.microsoft.com.Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Diversi set di documentazione Microsoft sono open source e ospitati in GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Non tutti i set di documenti sono completamente open source, ma per molti sono disponibili repository pubblici dove è possibile suggerire modifiche tramite richieste pull.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Questo approccio open source semplifica e migliora la comunicazione tra i progettisti del prodotto, i team dei contenuti e i clienti, oltre a offrire altri vantaggi:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • La pianificazione dei repository open source è visibile per poter ricevere commenti e suggerimenti sugli argomenti che più necessitano di documentazione.Open source repos plan in the open to get feedback on what docs are most needed.
  • La revisione dei repository open source è visibile per poter pubblicare il contenuto più utile già nella prima versione.Open source repos review in the open to publish the most helpful content on our first release.
  • Gli aggiornamenti dei repository open source sono visibili per poter migliorare costantemente il contenuto con facilità.Open source repos update in the open to make it easier to continuously improve the content.

L'esperienza utente in docs.microsoft.com viene direttamente integrata con i flussi di lavoro di GitHub così da risultare ancora più semplice.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. È possibile iniziare modificando il documento visualizzato,Start by editing the document you are viewing. dare un contributo revisionando i nuovi argomenti o segnalare problemi di qualità elevata.Or, help by reviewing new topics, or create quality issues.

Important

Tutti i repository che pubblicano contenuto in docs.microsoft.com adottano il Microsoft Open Source Code of Conduct (Codice di comportamento Open Source di Microsoft) o il .NET Foundation Code of Conduct (Codice di comportamento di .NET Foundation).All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Per altre informazioni, vedere Code of Conduct FAQ (Domande frequenti sul Codice di comportamento Open Source di Microsoft)For more information, see the Code of Conduct FAQ. oppure contattare opencode@microsoft.com o conduct@dotnetfoundation.org per eventuali domande o commenti.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Le correzioni minori o i chiarimenti inviati per la documentazione e gli esempi di codice nei repository pubblici sono coperti dalle Condizioni per l'utilizzo di docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Per le novità o le modifiche significative viene generato un commento nella richiesta pull con la richiesta di inviare un contratto di licenza online per contributi se non si è dipendenti Microsoft.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Prima che la richiesta pull venga esaminata o accettata, è necessario completare il modulo online.We need you to complete the online form before we can review or accept your pull request.

Modifiche rapide ai documenti esistentiQuick edits to existing documents

Le modifiche rapide semplificano il processo di segnalazione e correzione di piccoli errori e omissioni.Quick edits streamline the process to report and fix small errors and omissions in documents. Nonostante l'impegno, nei documenti pubblicati si possono riscontrare piccoli errori grammaticali e ortografici.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Anche se è possibile segnalare problemi per informare di errori, è più facile e veloce creare una richiesta pull per risolvere il problema, quando questa opzione è disponibile.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Alcune pagine della documentazione consentono di modificare il contenuto direttamente nel browser.Some docs pages allow you to edit content directly in the browser. In questo caso, sarà visualizzato un pulsante Modifica come quello mostrato di seguito.If so, you'll see an Edit button like the one shown below. Facendo clic sul pulsante Edit (o sulla versione equivalente localizzata) si accede al file di origine in GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Se il pulsante Modifica non è disponibile, ciò indica che la pagina della documentazione non è disponibile per la modifica.If the Edit button is missing, that means the documentation page is not available to be changed.

    Percorso del collegamento Modifica

  2. Fare quindi clic sull'icona a forma di matita per modificare l'articolo come illustrato.Next, click the pencil icon, to edit the article as shown. Se l'icona a forma di matita è inattiva, è necessario accedere all'account GitHub o crearne uno nuovo.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Posizione dell'icona a forma di matita

  3. Apportare le modifiche nell'editor Web.Make your changes in the web editor. Fare clic sulla scheda Preview changes (Anteprima modifiche) per controllare la formattazione della modifica.Click the Preview changes tab to check the formatting of your change.

  4. Dopo avere apportato le modifiche, scorrere fino alla fine della pagina.Once you have made your changes, scroll to the bottom of the page. Immettere un titolo e una descrizione per le modifiche e fare clic su Propose file change (Proponi modifica file), come illustrato nella figura seguente:Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Propose file change (Proponi modifica file)

  5. Dopo aver proposto la modifica, è necessario chiedere ai proprietari del repository di eseguire il "pull" delle modifiche nel loro repository.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Questa operazione viene eseguita tramite una "richiesta pull".This is done using something called a "pull request". Quando si fa clic su Propose file change (Proponi modifica file) nella figura precedente, dovrebbe essere visualizzata una pagina simile a quella nella figura seguente:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    creare una richiesta pull

    Fare clic su Crea richiesta pull, immettere un titolo (e facoltativamente una descrizione) per la richiesta pull e quindi fare di nuovo clic su Crea richiesta pull.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Se non si ha familiarità con GitHub, vedere la pagina delle informazioni sulle richieste pull.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Questo è tutto.That's it! I membri del team dei contenuti esamineranno ed eseguiranno il merge della richiesta pull.Content team members will review and merge your PR. Se sono state apportate modifiche più significative, è possibile ricevere alcune richieste di modifica.You may get some feedback requesting changes if you made larger changes.

L'interfaccia utente di modifica di GitHub è diversa a seconda delle autorizzazioni per il repository.The GitHub editing UI responds to your permissions on the repository. Le immagini precedenti si riferiscono a collaboratori che non hanno autorizzazioni di scrittura per il repository di destinazione.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub crea automaticamente un fork del repository di destinazione nell'account.GitHub automatically creates a fork of the target repository in your account. Se si ha l'accesso in scrittura al repository di destinazione, GitHub crea una nuovo ramo nel repository di destinazione.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Il nome del ramo ha il formato <GitHubId>-patch-n, che usa l'ID GitHub e un identificatore numerico per il ramo della patch.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Le richieste pull vengono usate per tutte le modifiche, anche per i collaboratori che hanno l'accesso in scrittura.We use pull requests for all changes, even for contributors that have write-access. La maggior parte dei repository ha il ramo master protetto e quindi gli aggiornamenti devono essere inviati come richieste pull.Most repositories have the master branch protected so that updates must be submitted as pull requests.

L'esperienza di modifica nel browser è ideale per modifiche secondarie o poco frequenti.The in-browser editing experience is best for minor or infrequent changes. Per pubblicare contributi più estesi oppure se si usano funzionalità Git avanzate, come la gestione dei rami o la risoluzione avanzata dei conflitti di merge, è necessario creare una copia tramite fork del repository e lavorare in locale.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Note

Se abilitato, è possibile modificare un articolo in qualsiasi lingua e, in base al tipo di modifica, si verificherà quanto segue:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Qualsiasi modifica linguistica approvata migliorerà anche il motore di traduzione automatica.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Qualsiasi modifica che cambia in modo significativo il contenuto dell'articolo verrà gestita internamente per inviare una modifica allo stesso articolo in inglese, in modo che venga localizzata in tutte le lingue in caso di approvazione.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. I miglioramenti consigliati non influiranno positivamente solo sugli articoli nella propria lingua, ma per tutte le lingue disponibili.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Esaminare le richieste pull aperteReview open PRs

Per leggere i nuovi argomenti prima che vengano pubblicati, è possibile controllare le richieste pull attualmente aperte.You can read new topics before they are published by checking the currently open PRs. Le revisioni seguono il processo del flusso GitHub.Reviews follow the GitHub flow process. È possibile visualizzare gli aggiornamenti proposti o i nuovi articoli nei repository pubblici.You can see proposed updates or new articles in public repositories. Esaminarli e aggiungere i commenti.Review them and add your comments. Esaminare i repository di documenti e controllare le richieste pull aperte per le aree a cui si è interessati.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. I commenti e suggerimenti della community sugli aggiornamenti proposti sono utili all'intera community.Community feedback on proposed updates helps the entire community.

Segnalare problemi di qualitàCreate quality issues

I documenti vengono continuamente rielaborati.Our docs are a continuous work in progress. La corretta formulazione dei problemi consente a Microsoft di impegnarsi maggiormente sulle priorità principali della community.Good issues help us focus our efforts on the highest priorities for the community. Specificare il maggior numero possibile di dettagli. In questo modo la segnalazione sarà più utile.The more detail you can provide, the more helpful the issue. Indicare le informazioni cercate.Tell us what information you sought. Indicare i termini di ricerca usati.Tell us the search terms you used. Se non si riesce a iniziare, spiegare come si vuole iniziare a esplorare una tecnologia con cui non si ha familiarità.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Molte delle pagine della documentazione di Microsoft includono una sezione Commenti nella parte inferiore, in cui è possibile fare clic per inviare Commenti sul prodotto oppure Commenti sul contenuto per registrare segnalazioni specifiche per l'articolo in questione.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Le segnalazioni danno avvio a una conversazione su ciò che è necessario.Issues start the conversation about what's needed. Il team dei contenuti risponderà a queste segnalazioni elencando le idee su ciò che è possibile aggiungere e chiederà l'opinione dell'utente.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Quando viene creata una bozza, viene chiesto all'utente di esaminare la richiesta pull.When we create a draft, we'll ask you to review the PR.

Maggiore coinvolgimentoGet more involved

Altri argomenti consentono di iniziare a contribuire concretamente a Microsoft Docs. Questi argomenti illustrano l'uso dei repository GitHub, gli strumenti Markdown e le estensioni usate nella piattaforma Microsoft Docs.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.