Oversikt over veiledningen for bidragsytere til Microsoft Docs

Velkommen til Microsoft Docs bidragsyterveiledningen!

Flere av dokumentasjonssettene fra Microsoft er åpen kilde og driftes av GitHub. Ikke alle dokumentsett er helt åpen kilde, men mange har offentlige repositorier der du kan foreslå endringer via pull-forespørsler (PR). Denne åpen kilde-tilnærmingen effektiviserer og forbedrer kommunikasjonen mellom produktteknikere, innholdsteam og kunder, og den har andre fordeler:

  • Repositorier med åpen kildekode er åpne for å få tilbakemelding om hvilke dokumenter som trengs mest.
  • Gjennomgang av repositorier med åpen kilde for å publisere det mest nyttige innholdet i den første versjonen.
  • Oppdatering av repositorier med åpen kildekode i det åpne for å gjøre det enklere å kontinuerlig forbedre innholdet.

Brukeropplevelsen på Microsoft Docs integrerer GitHub-arbeidsflyter direkte for å gjøre det enda enklere. Begynn med å redigere dokumentet du viser. Eller hjelp ved å se gjennom nye emner eller opprette kvalitetsproblemer.

Viktig

Alle repositorier som publiserer til Microsoft Docs har tatt i bruk Microsofts regler for god oppførsel for åpen kilde eller .NET Foundations regler for god oppførsel. Hvis du vil ha mer informasjon, se Vanlige spørsmål om regler for god opptreden. Kontakt opencode@microsoft.com eller conduct@dotnetfoundation.org med spørsmål eller kommentarer.

Mindre rettelser eller klargjøring av dokumentasjon og kodeeksempler i offentlige repositorier dekkes i Vilkår for bruk av docs.microsoft.com. Nye eller betydelige endringer genererer en kommentar i pull-forespørselen og ber deg om å sende inn en lisensavtale for bidrag på nettet hvis du ikke er en Microsoft-ansatt. Du må fylle ut det elektroniske skjemaet før vi kan se gjennom eller godta pull-forespørselen din.

Hurtigredigeringer i dokumentasjon

Raske redigeringer effektiviserer prosessen for å rapportere og løse små feil og utelatelser i dokumentasjonen. Til tross for at vi arbeider hardt for å unngå det,sniker det seg inn små grammatiske feil og stavefeil i dokumentene vi publiserer. Selv om du kan opprette problemer for å rapportere feil, er det raskere og enklere å opprette en pull-forespørsel for å løse problemet når alternativet er tilgjengelig.

  1. Noen dokumentsider tillater deg å redigere innhold direkte i nettleseren. I så fall ser du en Rediger-knapp som den som vises nedenfor. Hvis du velger Rediger -knappen (eller tilsvarende lokalisert), kommer du til kildefilen på GitHub.

    Plasseringen til koblingen for redigeringsartikkelen.

    Hvis Rediger-knappen ikke finnes, betyr det at innholdet ikke er åpent for offentlige bidrag. Noen sider genereres (for eksempel fra innebygd dokumentasjon i kode) og må redigeres i prosjektet de tilhører.

  2. Velg blyantikonet for å redigere artikkelen. Hvis blyant-ikonet er grått, må du enten logge deg på en GitHub-konto, eller opprette en ny konto.

    Plasseringen til forgreningen og rediger blyantikonet.

  3. Rediger filen i redigeringsprogrammet for nettet. Velg Forhåndsvisning-fanen for å kontrollere formateringen av endringene.

  4. Når du er ferdig med å redigere, ruller du til bunnen av siden. Skriv inn en tittel og eventuelt en beskrivelse av endringene i området Foreslå endringer . Tittelen blir den første linjen i utføringsmeldingen. Velg Foreslå endringer for å utføre endringene:

    Foreslå og utfør filendringer.

  5. Nå som du har foreslått og utført endringene dine, må du be eierne av repositoriet om å «trekke» endringene inn i repositoriet. Dette gjøres ved hjelp av noe som kalles en pull-forespørsel (PR). Når du velger Foreslå endringer, vises en ny side som ligner på følgende:

    Sammenlign endringer og opprett pull-forespørsel.

    Velg Opprett pull-forespørsel. Skriv deretter inn en tittel og en beskrivelse for pull-forespørselen, og velg deretter Opprett pull-forespørsel. Hvis gitHub er nytt for deg, kan du se Om pull-forespørsler for mer informasjon.

  6. Det var det! Medlemmer av innholdsteamet ser gjennom pull-forespørselen og fletter den når den godkjennes. Du kan få tilbakemelding som ber om endringer.

Brukergrensesnittet for redigering på GitHub reagerer på tillatelsene du har på repositoriet. De foregående bildene er for bidragsytere som ikke har skrivetilgang til målrepositoriet. GitHub oppretter automatisk en forgrening av målrepositoriet i kontoen din. Det nylig opprettede forgreningsnavnet har skjemaet GitHubUsername/RepositoryName som standard. Hvis du har skrivetilgang til målrepositoriet, for eksempel forgreningen, oppretter GitHub en ny gren i målrepositoriet. Grennavnet har standard skjemaoppdateringn ved hjelp av en numerisk identifikator for oppdateringsgrenen.

Vi bruker pull-forespørsler for alle endringer, selv for bidragsytere som har skrivetilgang. De fleste repositorier beskytter standardgrenen slik at oppdateringer må sendes inn som pull-forespørsler.

Redigering i nettleser er best for små endringer og for endringer som ikke skjer ofte. Hvis du leverer store bidrag eller bruker avanserte Git-funksjoner (for eksempel grenadministrering eller løsing av avanserte sammenslåingskonflikter), må du opprette en forgrening av repositoriet og arbeide lokalt.

Obs!

De fleste lokaliserte dokumentasjonene tilbyr ikke muligheten til å redigere eller gi tilbakemelding gjennom GitHub. Hvis du vil gi tilbakemelding om lokalisert innhold, kan du bruke e-postmalen som er tilgjengelig på aka.ms/DocSiteLocFeedback.

Gå gjennom åpne pull-forespørsler

Du kan lese nye emner før de publiseres ved å kontrollere den åpne PR-køen. Gjennomganger følger prosessen for GitHub-flyt. Du kan se forslåtte oppdateringer og nye artikler i offentlige repositorier. Gå gjennom dem, og legg til dine kommentarer. Se på docs-repositorier, og sjekk de åpne pull-forespørslene for områder som interesserer deg. Tilbakemeldinger fra fellesskapet om foreslåtte oppdateringer hjelper hele fellesskapet.

Opprett kvalitetssaker

Vi jobber alltid på dokumentasjonen vår. Hvis sakene har høy kvalitet, kan vi fokusere på sakene med høyest prioritet i felleskapet. Jo flere detaljer du har, jo nyttigere er saken. Fortell oss hva du så etter. Fortell oss hvilke ord du søkte etter. Hvis du ikke kan komme i gang, kan du fortelle oss hvordan du vil begynne å utforske ny teknologi.

Mange av microsofts dokumentasjonssider har en tilbakemeldingsinndeling nederst på siden der du kan velge å gi tilbakemelding om produktet eller tilbakemeldinger om innhold for å spore problemer som er spesifikke for denne artikkelen.

Saker starter samtalen om hva som må gjøres. Innholdsgruppen svarer på sakene med ideer om hva vi kan legge til, og spør hva du syns. Når vi har opprettet et utkast, vil vi be deg om å gå gjennom pull-forespørselen.

Gjør mer

Andre emner i denne veiledningen hjelper deg med å komme i gang med å bidra produktivt til Microsoft Docs. De forklarer hvordan du arbeider med GitHub-repositorier, Markdown-verktøy og -utvidelser som brukes i Microsoft Docs plattformen.