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

Instructions how to update Stride code base #10

Open
VaclavElias opened this issue Jul 25, 2022 · 1 comment
Open

Instructions how to update Stride code base #10

VaclavElias opened this issue Jul 25, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation p1 Critical, and inhibits core functionality

Comments

@VaclavElias
Copy link
Collaborator

VaclavElias commented Jul 25, 2022

Stride Contributor Workflow

Make sure you are familiar with our main GitHub Stride page. The following steps might work for you in many scenarios if you are new to Stride. The advance contributors can skip some steps or you might be asked to do PR so the reviewers and approvers can see the code changes easier, and discuss your contribution directly through PR comments.

  1. Create a new Issue and Discuss with the community or take ownership of existing issue
    or run it from VS's toolbar.
  2. Fork this repository or clone directly git lfs clone https://github.com/stride3d/stride.git
    • make sure LFS (Large File Storage) is used
  3. Open \build\Stride.sln with Visual Studio 2022 and build Stride.GameStudio (it should be the default startup project)
  4. Create and checkout a new branch e.g. 457-fsharp-fix
    • the branch name can be IssueNumber-short-issue-title
  5. Update SharedAssemblyInfo.cs temporarily to create a test version for your local NuGet packages   
    • Make sure the number is higher than existing public NuGet number   
    • Example PublicVersion = "4.1.1.0-fix457"
  6. Make updates in the Stride code, fixing an issue or adding a new feature code
  7. Build project
  8. Packages should appear in %localappdata%\Stride\NugetDev
    • This path should be also in your VS Package Sources
  9. Update Stride NuGet packages in your application to 4.1.1.0-fix457
  10. Test, test, test
  11. Commit changes in your branch
  12. Create PR, follow the PR guide
    • make sure you get the PublicVersion to the original state as the maintainers will take care of correct versioning. We only used it locally for our development.

In the F# example, add 
Snippet<PackageReference Include="Stride.Core.Assets.CompilerApp" Version="4.1.1.0-fix457" IncludeAssets="build;buildTransitive" />

@VaclavElias VaclavElias added the documentation Improvements or additions to documentation label Jul 29, 2022
@VaclavElias VaclavElias added the p1 Critical, and inhibits core functionality label Feb 18, 2024
@VaclavElias
Copy link
Collaborator Author

Not sure why I added it here. Probably would need to go to Stride Docs..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation p1 Critical, and inhibits core functionality
Projects
None yet
Development

No branches or pull requests

1 participant