To submit a pull request (PR) for an MvvmCross issue, follow these detailed steps:
1. Reproduce the Issue: First, ensure you can reproduce the issue consistently. This is crucial for creating a reliable PR. If possible, use the MvvmCross Playground sample app to demonstrate the problem. This sample is included in the MvvmCross source code and provides a controlled environment to isolate and reproduce issues[1].
2. Gather Information: Collect as much relevant information as possible about the issue. This includes:
- Steps to Reproduce: Provide a clear, step-by-step guide on how to reproduce the issue.
- Platform(s) Affected: Specify which platforms (e.g., Android, iOS, UWP) are experiencing the problem.
- Code Snippets: Include any relevant code snippets that are involved in the issue.
- Expected vs. Actual Behavior: Describe what you expect to happen versus what actually happens[3].
3. Create a Branch: In your local copy of the MvvmCross repository, create a new branch for your changes. This branch should be based on the latest version of the MvvmCross code (e.g., `main` or `develop` branch). Use a descriptive name for your branch that relates to the issue you're addressing.
4. Make Changes: Implement the fix or enhancement in your branch. Ensure that your changes are minimal and focused on resolving the specific issue. If you're fixing a bug, try to include a test to verify the fix.
5. Test Your Changes: Thoroughly test your changes to ensure they resolve the issue without introducing new problems. Use the Playground sample app or your own test project to verify the fix.
6. Format Your Code: Ensure your code adheres to MvvmCross coding standards and formatting guidelines. You can use tools like Roslyn analyzers to help maintain consistency[4].
7. Commit Your Changes: Commit your changes with a clear, descriptive commit message. The message should include a reference to the issue number if applicable (e.g., "Fixes #XXXX: Brief description of changes").
8. Push Your Branch: Push your branch to your fork of the MvvmCross repository on GitHub.
9. Submit the PR: On GitHub, navigate to your branch and click the "New pull request" button. Select the base branch (usually `main` or `develop`) and fill in the PR description. Include:
- A brief summary of the changes.
- Any relevant details or discussion points.
- Links to related issues or discussions.
10. Engage with the Community: After submitting your PR, be prepared to engage with the MvvmCross community. They may request additional information, suggest changes, or ask you to update your PR based on feedback.
11. Update Your PR: If requested, update your PR by pushing new commits to your branch. GitHub will automatically update the PR with your new changes.
By following these steps, you can effectively contribute to MvvmCross and help resolve issues in a collaborative manner.
Citations:[1] https://nicksnettravels.builttoroam.com/post-2018-07-31-debugging-and-contributing-to-mvvmcross-aspx/
[2] https://www.mvvmcross.com/mvvmcross-5-release/
[3] https://www.nuget.org/packages/MvvmCross/
[4] https://www.mvvmcross.com/documentation/advanced/analysis
[5] https://stackoverflow.com/questions/61632172/mvvmcross-problem-with-adding-new-contentpage
[6] https://stackoverflow.com/questions/61528243/mvvmcross-pdb-debug-symbols-not-loading-in-visual-studio-2019
[7] https://github.com/MvvmCross/MvvmCross/issues/1032
[8] https://github.com/MvvmCross/MvvmCross/issues/215