Update instructions in README.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation
Research direction
Start with README.md and review the related pull request #8085 and issue #8408 for the migration and validation context. Document how to update the SDL library and how to validate that the update works; the README should give contributors enough guidance to perform both tasks safely.
Written by the indexing model from the issue text.
Description
To facilitate help keeping SDL up-to-date, I think it would be valuable to include primer material in the README to lower the entry requirements. That material would have to cover both how to update the library and validate that it works.
This is high value, in my opinion, as the current (not yet in use by MG) version already fixes a couple of bugs, and SDL2 has had loads of stable bugfix releases in the last 9 months.
Related issues
- https://github.com/MonoGame/MonoGame/pull/8085 (Mentions the validation holding up migrating MonoGame)
- https://github.com/MonoGame/MonoGame/issues/8408 (The controller DB removal, which will be even more incentive to keep SDL up-to-date)
I'd happily contribute to both, but my unknown unknowns mean I don't know what I may break. That said, I'd happily snag pointers to look into it.
- Dominant language
- C#
- Stars
- 9
- Forks
- 12
- Avg merge
- 14h 7m
- Merged PRs (30d)
- 2
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
microsoft/onnxruntime-genai#2633 ·
Maintainers usually reply within 1 day
-
python triage
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
microsoft/semantic-kernel#14491 ·
Maintainers usually reply within 2 days
-
area:jobads-cv FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1878 ·
Maintainers usually reply within 1 day
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
pnp/pnpcore#1878 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15331 · 2 comments ·
Maintainers usually reply within 1 day