microsoft / microsoft/go

Move `eng/run.ps1` to `run.ps1` (and other submodule freedoms)

Open
#401 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We made some choices back when we were using a Git fork that we should revisit now that the upstream code is contained in a submodule:

  • eng/run.ps1 -> run.ps1
    • More generally, we don't have to be concerned about stuffing all of our code into eng to keep it isolated. We can move out eng/doc to doc (or docs), too.
  • Remove _ for eng/_core, eng/_util
    • The Go tests traversed the entire Go repository, and _ was how our code was avoiding being tested as if it was part of the standard library.
    • eng/core.
    • Consider other names that are more descriptive than "core" and "util", and put them in the root of the repo?
  • Move eng/artifacts to artifacts. This is easier to navigate to, and it's more familiar to devs who also work with the .NET source code.

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 repository layout around eng/run.ps1, eng/doc, eng/_core, eng/_util, and eng/artifacts, along with the submodule-related context in the issue. Define the target names and module boundaries before making changes; done means the proposed directories are consistently relocated without breaking the repository’s Go or build workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.