Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Contributor Guide #6127

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,3 +333,43 @@
[EnvironmentVariablesExtensions.cs](./src/Shared/EnvironmentVariables/EnvironmentVariablesExtensions.cs)
for an example of a file copied from another project and attributed in the [3rd
party notices](./THIRD-PARTY-NOTICES.TXT) file.


Check failure on line 337 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Multiple consecutive blank lines

CONTRIBUTING.md:337 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md012.md
## Troubleshooting Common Issues

### 1. SDK Version Compatibility Issues

**Problem:** The project requires .NET SDK version `9.0.100-RC.1.24452.12`, but developers may download an incompatible version.

Check failure on line 342 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Line length

CONTRIBUTING.md:342:81 MD013/line-length Line length [Expected: 80; Actual: 128] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md

**Solution:**
- Explicitly state the required .NET SDK version upfront in the documentation.

Check failure on line 345 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Unordered list style

CONTRIBUTING.md:345:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md

Check failure on line 345 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Lists should be surrounded by blank lines

CONTRIBUTING.md:345 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Explicitly state the require..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md032.md
- Provide direct links to the required SDK version.

Check failure on line 346 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Unordered list style

CONTRIBUTING.md:346:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md
- Verify your installed SDK version with:

Check failure on line 347 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Unordered list style

CONTRIBUTING.md:347:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md
```sh

Check failure on line 348 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Fenced code blocks should be surrounded by blank lines

CONTRIBUTING.md:348 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```sh"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md031.md
dotnet --version
```

Check failure on line 350 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Fenced code blocks should be surrounded by blank lines

CONTRIBUTING.md:350 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md031.md
- If you have an incompatible SDK, download the correct version [here](https://dotnet.microsoft.com/download/dotnet/9.0).

Check failure on line 351 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Unordered list style

CONTRIBUTING.md:351:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md

### 2. Build and Test Challenges

#### Version Mismatch Between Assemblies

**Issue:** CS1705 version conflict when referencing OpenTelemetry.Api package.

**Fix:**
- Ensure dependencies are updated by running:

Check failure on line 360 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-md / run-markdownlint

Unordered list style

CONTRIBUTING.md:360:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md
```sh
dotnet restore
```
- If the issue persists, force-reinstall dependencies:
```sh
dotnet nuget locals all --clear
dotnet restore
```

#### Dynamically Referenced Packages Causing Compatibility Problems

**Solution:**
- Ensure your `global.json` file correctly specifies the required SDK version.
- If using multiple SDK versions, use `dotnet --list-sdks` to confirm correct installation.
- Consider using a virtual environment or containerized build system to maintain a consistent development environment.
Loading