Skip to content

Add CONTRIBUTING.md #123

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.

Sign up for GitHub

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

Open
saadkhalidkhan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CONTRIBUTING.md #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing to Reorderable

Thank you for your interest in contributing to Reorderable.

## Development setup

Open this project with **Android Studio Preview**.

Install the [Kotlin Multiplatform Mobile plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile) before opening the project.

## Running the demo app

### Android

Open the project in Android Studio and run the demo app.

### iOS

Open the `iosApp` project in Xcode and run the app, or add the iOS run configuration to Android Studio (requires the KMM plugin).

### Web

```bash
./gradlew :composeApp:wasmJsBrowserDevelopmentRun
```

### Desktop

```bash
./gradlew :demoApp:composeApp:run
```

## Building the library

```bash
./gradlew :reorderable:compileKotlinJvm :demoApp:composeApp:compileDebugKotlinAndroid
```

## Pull requests

1. Fork the repository and create a feature branch from `main`.
2. Keep changes focused and include a clear description of the problem and solution.
3. Verify the demo app and library compile locally before opening a PR.
4. Link related issues when applicable.

## License

By contributing, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1839,6 +1839,8 @@ To run the desktop demo app, run `./gradlew :demoApp:ComposeApp:run`.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and pull request guidelines.

Open this project with Android Studio Preview.

You'll want to install the [Kotlin Multiplatform Mobile plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile) in Android Studio before you open this project.
Expand Down