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.

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

Move contribution steps to its own file #98

Merged
merged 1 commit into from
Nov 14, 2023
Merged

Move contribution steps to its own file #98

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
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing to WoltModalSheet

To get started with contributing, please follow the steps below:

1. [Fork the wolt_modal_sheet repo](https://github.com/woltapp/wolt_modal_sheet/fork) on GitHub.
2. Clone your forked repo locally.
3. Ensure you have [Melos](https://pub.dev/packages/melos/install) installed.
```bash
dart pub global activate melos
```
4. Use Melos to bootstrap the project.
```bash
melos bootstrap
```
5. Create a new branch from the `main` branch.
6. Make your changes.
7. Create a pull request.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add a note here:
Before creating a pull request, run the Dart format and Flutter analyze for a merge check using Melos, ensuring compatibility with the minimum supported Flutter version, which is 3.7.2.

melos run format
melos run analyze

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about it. I think, it is better to include it in the pull request template. So that they will need to click check mark to verify that melos analyze doesn't produce any errors, etc.

Copy link
Collaborator Author

@yunusemrebakir yunusemrebakir Nov 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So in contributing.md; we introduce how the contribution works, and handle the details in the respective area, in this case in the PR.
I liked how it is handled in flutterfire, for example.

18 changes: 0 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,21 +538,3 @@ current state:
guidelines and best practices by showing real-world examples highlighting
what to do—and what not to do. It also covers the technical details of the
implementation. The recording of the talk can be found [here](https://www.youtube.com/live/X3bw1pr1kyQ?si=1SielcIbW6rF-4IC&t=4449).

### Contributing

To get started with contributing, please follow the steps below:

1. [Fork the wolt_modal_sheet repo](https://github.com/woltapp/wolt_modal_sheet/fork) on GitHub.
2. Clone your forked repo locally.
3. Ensure you have [Melos](https://pub.dev/packages/melos/install) installed.
```bash
dart pub global activate melos
```
4. Use Melos to bootstrap the project.
```bash
melos bootstrap
```
5. Create a new branch from the `main` branch.
6. Make your changes.
7. Create a pull request.