Skip to content

Commit 60579a2

Browse files
committed
Update contribution guide with example of PR workflow
1 parent c58a518 commit 60579a2

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/content/docs/docs/contributing.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can build and deploy apps using local modifications to any of the Skip Core
3636

3737
Launching your app from Android Studio will **not** use your Workspace's local libraries by default. If you'd like to work in Android Studio, edit your app's `Android/settings.gradle.kts` file to point Android Studio at Xcode's build, as described in [Cross-Platform Topics](/docs/platformcustomization/#android-studio-setup).
3838

39-
:::tip
39+
:::note
4040
If Android Studio appears to be stuck on the official library releases rather than your local versions, use its `File → Sync Project with Gradle Files` command to force Android Studio to re-evaluate `settings.gradle.kts`.
4141
:::
4242

@@ -81,6 +81,16 @@ So a sample workflow making a contribution would look like this:
8181
If the PRs involve changing the API surface (including removing `@unavailable` annotations), then the CI will likely fail on everything except the `SkipUI` changes due to the fact that the other packages are only built against the most recent release tags of `SkipUI` rather than the `main` branch. That's OK: when the PRs are reviewed, they will all be reviewed together and once merged and included in a new release, the CI will become green again.
8282
:::
8383

84+
### Workflow example
85+
86+
An example of a series of pull requests that demonstrates the workflow of adding a new feature to SkipUI can be seen at:
87+
88+
1. Add `View.contextMenu` modifier: https://github.com/skiptools/skip-ui/pull/356
89+
2. Support `View.contextMenu` modifier: https://github.com/skiptools/skip-fuse-ui/pull/93
90+
3. Add ContextMenuPlayground to demonstrate SkipUI `View.contextMenu`: https://github.com/skiptools/skipapp-showcase/pull/74
91+
4. Add ContextMenuPlayground to demonstrate SkipFuseUI `View.contextMenu`: https://github.com/skiptools/skipapp-showcase-fuse/pull/50
92+
93+
8494
## Integration Frameworks
8595

8696
Integration frameworks are the lifeblood of Skip: they are the optional modules that provide a single API to equivalent functionality on Android and Darwin platforms alike. A subset of the existing integration frameworks is available at the [modules index](/docs/modules/), but many more exist under the [Skip GitHub organization repositories](https://github.com/orgs/skiptools/repositories). Many of these frameworks have been contributed by users over the years.

0 commit comments

Comments
 (0)