microsoft / microsoft/go

Create CONTRIBUTING.md

Open
#1,617 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
431
Forks
44
Avg merge
21h 18m
Merged PRs (30d)
30

Description

We have https://github.com/microsoft/go?tab=readme-ov-file#contributing and https://github.com/microsoft/go/blob/microsoft/main/eng/doc/DeveloperGuide.md, but the Microsoft Open Source documentation recommends a CONTRIBUTING.md file.

We have no obligation, but it might be worth seeing if it stands out more, and if perhaps it will help to have a location for contribution info with an amount of detail somewhere between our readme and the developer guide. Or maybe we just move the developer guide altogether.

(See https://github.com/microsoft/go-lab/issues/181#issuecomment-2776466889)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the README's contributing section and eng/doc/DeveloperGuide.md, then compare them with the Microsoft Open Source CONTRIBUTING guidance linked in the issue. Determine whether to add CONTRIBUTING.md, move the developer guide, or leave the existing structure; done means the contribution information has a clear, agreed location and appropriate level of detail.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.