dotnet/runtime

Facades and NotSupported assemblies are bloated with resources they don't use

Open

#28,888 opened on Mar 6, 2019

View on GitHub
 (9 comments) (2 reactions) (0 assignees)C# (5,445 forks)batch import
area-Infrastructure-librariesenhancementhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

Often times we have builds that cross-compile and have very different implementations. Our resource conventions don't force folks to think about this, so the resources are often a superset of all configurations.

We should change the defaults so that this isn't the case.

I propose the following:

  1. By default PartialFacades should not include any resources, unless a project opts-in. Folks should discover this relatively easily as SR.Foo will fail to work in the partial source. They can fix it by setting a flag and potentially providing specific resources for that build of the library.
  2. By default NotSupported assemblies require a unique resx. We can change the path convention to something like Resources\NotSupported.resx instead of strings.resx

Across all our builds this will save over a MB of unused resources.

Contributor guide

Research direction
Investigate the current resource inclusion behavior in PartialFacades and NotSupported assemblies, then modify the build scripts to exclude resources by default and implement opt in mechanism. For NotSupported assemblies, change the resource path convention to use a unique resx file per assembly.
Tech stack
csharp
Domain
build system
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40