stride3d / stride3d/stride-docs

Release Notes Instructions

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

Nobody has claimed this yet.

enhancement p3 question wiki
Dominant language
PowerShell
Stars
39
Forks
74
Avg merge
3h 36m
Merged PRs (30d)
2

Description

Let's add some basic instructions about Release Notes, because they are used also in the Launcher.

Do mention ReleaseNotesViewModel.cs which contains the logic and the path.

Context

xen2:

the release note, right now, were duplicated between website and doc
you think it's OK as is, or do you have other ideas?

Vaso:

I would follow Microsoft approach, they create a blog post with some intro text, context, even it is a few sentences, and they might include all updates or they just pick up something. While the Release Notes can be just a summary, the structure like now, all PRs, but not necessarily details. Ideally, we should also create separate blog posts about big features on the top of all this. So it really depends on the man power we have. If there is no one to help. we can just copy Release Notes to the Blog post like in the past but if we do have more time

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 locating and reading ReleaseNotesViewModel.cs to understand the release-note logic and determine its path. Add basic documentation explaining Release Notes, their use in the Launcher, and where the logic lives; the instructions should be complete without duplicating the full release notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.