|
|
@@ -0,0 +1,55 @@
|
|
|
+# Contribution Workflow for Stride Projects
|
|
|
+
|
|
|
+This guide outlines the fundamental workflow for contributing to various Stride projects, including the Stride Engine, Stride website, and Stride documentation. Whether you're a seasoned contributor or new to the project, this workflow ensures your contributions are effectively integrated.
|
|
|
+
|
|
|
+## Overview
|
|
|
+
|
|
|
+The contribution process involves several key steps, from forking the repository to having your changes merged into the main project. This workflow is applicable to contributions to the Stride Engine, Stride website, and Stride documentation.
|
|
|
+
|
|
|
+``` mermaid
|
|
|
+%% Define styles
|
|
|
+
|
|
|
+%% Main Graph
|
|
|
+graph TB
|
|
|
+
|
|
|
+%% Nodes
|
|
|
+ Start[Start]
|
|
|
+ A[Fork the Repository]
|
|
|
+ B[Create Branch 'X']
|
|
|
+ C[Make Updates on Branch 'X']
|
|
|
+ D{Has the Upstream Changed?}
|
|
|
+ E[Sync/Merge Upstream to Forked Main Branch]
|
|
|
+ F[Sync/Merge Forked Main Branch to Branch 'X']
|
|
|
+ G[Test your updates]
|
|
|
+ H["Create a Pull Request (PR)"]
|
|
|
+ I[Wait for the PR to be Merged]
|
|
|
+ J[Address PR Feedback]
|
|
|
+ K[Sync/Merge Upstream to Your Forked Main Branch]
|
|
|
+ L{Do You Want to Make More Updates?}
|
|
|
+ Z[End]
|
|
|
+
|
|
|
+%% Edges
|
|
|
+ Start --> A --> B --> C --> D
|
|
|
+ D -->|Yes| E
|
|
|
+ D -->|No| G
|
|
|
+ E --> F --> G
|
|
|
+ G --> H --> I --> J --> K --> L
|
|
|
+ L -->|Yes| B
|
|
|
+ L -->|No| Z
|
|
|
+```
|
|
|
+
|
|
|
+## Detailed Steps
|
|
|
+
|
|
|
+1. **Fork the Repository**: Start by forking the repository of the project you wish to contribute to
|
|
|
+1. **Create a Branch**: Name your branch appropriately and start making your changes
|
|
|
+1. **Make and Test Updates**: Implement your changes and test them within your branch
|
|
|
+1. **Review and Create a PR**: Review your updates and create a Pull Request to the main repository
|
|
|
+1. **Address Feedback**: If there is any feedback on your PR, address it to improve your contribution
|
|
|
+1. **Final Merging**: Once your PR is approved, it will be merged into the main project
|
|
|
+
|
|
|
+## Best Practices
|
|
|
+1. Ensure your updates align with the project goals and guidelines
|
|
|
+1. Keep your fork synchronized with the main repository to avoid conflicts
|
|
|
+1. Engage with the Stride community for support and collaboration
|
|
|
+
|
|
|
+For more specific guidelines related to each project, refer to their respective contribution documentation.
|
Vaclav Elias