Merge pull request zino-hofmann#503 from mainawycliffe/update-contrib…

…uting-guidelines docs: update contributing guidelines
henriquedezani · Jan 14, 2020 · d71b553 · d71b553
2 parents f9d9b9a + f16c6b3
commit d71b553
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -69,10 +69,18 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 3. Fork the `zino-app/graphql-flutter` repo.
 4. Make your changes in a new git branch:
 
+    - For fixes bug fixes:
+
    ```shell
-   git checkout -b my-fix-branch beta
+   git checkout -b my-fix-branch master
    ```
 
+    - For new features:
+
+     ```shell
+    git checkout -b my-fix-branch beta
+    ```
+
 5. Create your patch, **including appropriate test cases**.
 6. Add and Update the documentation for your feature.
 7. Commit your changes using a descriptive commit message that follows our
@@ -92,15 +100,15 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     git push origin my-fix-branch
     ```
 
-10. In GitHub, send a pull request to `graphql-flutter:beta`.
+10. In GitHub, send a pull request to `graphql-flutter:master` for fixes and `graphql-flutter:beta` for new features.
 
 - If we suggest changes then:
 
   - Make the required updates.
   - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
 
     ```shell
-    git rebase beta -i
+    git rebase master -i
     git push -f
     ```
 
@@ -117,10 +125,10 @@ from the main (upstream) repository:
   git push origin --delete my-fix-branch
   ```
 
-- Check out the beta branch:
+- Check out the master branch:
 
   ```shell
-  git checkout beta -f
+  git checkout master -f
   ```
 
 - Delete the local branch:
@@ -129,10 +137,10 @@ from the main (upstream) repository:
   git branch -D my-fix-branch
   ```
 
-- Update your beta with the latest upstream version:
+- Update your master with the latest upstream version:
 
   ```shell
-  git pull --ff upstream beta
+  git pull --ff upstream master
   ```
 
 ## <a name="rules"></a> Coding Rules

diff --git a/packages/graphql/README.md b/packages/graphql/README.md
@@ -27,6 +27,10 @@ And then import it inside your dart code:
 import 'package:graphql/client.dart';
 ```
 
+## Migration Guide
+
+Find the migration from version 2 to version 3 [here](./../../changelog-v2-v3.md).
+
 ### Parsing at build-time
 
 To parse documents at build-time use `ast_builder` from

diff --git a/packages/graphql_flutter/README.md b/packages/graphql_flutter/README.md
@@ -45,6 +45,10 @@ Now inside your Dart code, you can import it.
 import 'package:graphql_flutter/graphql_flutter.dart';
 ```
 
+## Migration Guide
+
+Find the migration from version 2 to version 3 [here](./../../changelog-v2-v3.md).
+
 ## Usage
 
 To use the client it first needs to be initialized with a link and cache. For this example, we will be using an `HttpLink` as our link and `InMemoryCache` as our cache. If your endpoint requires authentication you can concatenate the `AuthLink`, it resolves the credentials using a future, so you can authenticate asynchronously.
@@ -542,14 +546,14 @@ This is currently our roadmap, please feel free to request additions/changes.
 
 | Feature                 | Progress |
 | :---------------------- | :------: |
-| Queries                 |    ✅    |
-| Mutations               |    ✅    |
-| Subscriptions           |    ✅    |
-| Query polling           |    ✅    |
-| In memory cache         |    ✅    |
-| Offline cache sync      |    ✅    |
-| GraphQL pload           |    ✅    |
-| Optimistic results      |    ✅    |
+| Queries                 |    ✅     |
+| Mutations               |    ✅     |
+| Subscriptions           |    ✅     |
+| Query polling           |    ✅     |
+| In memory cache         |    ✅     |
+| Offline cache sync      |    ✅     |
+| GraphQL pload           |    ✅     |
+| Optimistic results      |    ✅     |
 | Client state management |    🔜    |
 | Modularity              |    🔜    |