creativecreatorormaybenot

M

  1 +# Steps
  2 +
  3 +The following steps are based on [flutter/plugin's contributing guide](https://github.com/flutter/plugins/blob/2ea66626c245a4373a6e07706ab2e7d471e25bd6/CONTRIBUTING.md).
  4 +
  5 +## Creating a fork
  6 +
  7 + * If you have not yet configured your machine with an SSH key that is known to GitHub, then follow [GitHub's directions](https://help.github.com/articles/generating-ssh-keys/) to generate an SSH key.
  8 + * Fork [this repository](https://github.com/creativecreatorormaybenot/wakelock/new) using the "Fork" button in the upper right corner of the repository's GitHub page.
  9 + * `git clone git@github.com:<github_user_name>/wakelock.git`
  10 + * `cd wakelock`
  11 + * `git remote add upstream git@github.com:creativecreatorormaybenot/wakelock.git`
  12 + This ensures that `git fetch` fetches from this remote repository instead of from your own fork to get the latest changes.
  13 +
  14 +## Creating a patch
  15 +
  16 + * `git fetch upstream`
  17 + * `git checkout upstream/master -b <name_of_your_branch>`
  18 + * Now, you can change the code necessary for your patch.
  19 +
  20 + Make sure that you bump the version in [`pubspec.yaml`](https://github.com/creativecreatorormaybenot/wakelock/blob/master/pubspec.yaml) and add an entry to [`CHANGELOG.md`](https://github.com/creativecreatorormaybenot/wakelock/blob/master/CHANGELOG.md).
  21 + The version format is `r.M.m+p`. You will want to increment one of these values and which one you increment depends on the impact of your patch: `p` for simple patches, `m` for minor versions, `M` for major versions, and `r` for released. Do not forget to reset the values to the right of the value you incremented to 0. You should omit `+0`.
  22 + * `git commit -am "<commit_message>"`
  23 + * `git push origin <name_of_your_branch>`
  24 +
  25 +After having followed these steps, you are ready to [create a pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork).
  26 +The GitHub interface makes this very easy by providing a button on your fork page that creates a pull request with changes from a recently pushed to branch.
  27 +Alternatively, you can also use `git pull-request` via [GitHub hub](https://hub.github.com/).
  28 +
  29 +# Notes
  30 +
  31 + * You should remember to exlcude all files and directories your IDE might generate using the `.gitignore` files (if they do not already contain them for your IDE).
  32 + If you feel like you can make useful additions to any of the `.gitignore` files, you can include them in your pull request, potentially with an explanation.
  33 +
  34 + * It is probably easier for you to run the integration tests for the plugin locally before opening a pull request using `flutter drive --target=test_driver/app.dart` in the `example` directory.
  35 + This way you can ensure that any changes you have made work properly. Furthermore, you might also want to add some tests if you implement new functionality.
1 -BSD 2-Clause License 1 +BSD 3-Clause License
2 2
3 Copyright (c) 2019, creativecreatorormaybenot 3 Copyright (c) 2019, creativecreatorormaybenot
4 All rights reserved. 4 All rights reserved.
@@ -13,6 +13,10 @@ modification, are permitted provided that the following conditions are met: @@ -13,6 +13,10 @@ modification, are permitted provided that the following conditions are met:
13 this list of conditions and the following disclaimer in the documentation 13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution. 14 and/or other materials provided with the distribution.
15 15
  16 +3. Neither the name of the copyright holder nor the names of its
  17 + contributors may be used to endorse or promote products derived from
  18 + this software without specific prior written permission.
  19 +
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -46,7 +46,9 @@ bool isEnabled = await Wakelock.isEnabled; @@ -46,7 +46,9 @@ bool isEnabled = await Wakelock.isEnabled;
46 46
47 If you want to wait for the wakelock toggle on Android or iOS to complete (which takes an insignificant amount of time), you can also await either of `Wakelock.enable`, `Wakelock.disable`, and `Wakelock.toggle`. 47 If you want to wait for the wakelock toggle on Android or iOS to complete (which takes an insignificant amount of time), you can also await either of `Wakelock.enable`, `Wakelock.disable`, and `Wakelock.toggle`.
48 48
49 -## Note 49 +## Notes
50 50
51 This plugin is originally based on [`screen`](https://pub.dev/packages/screen). 51 This plugin is originally based on [`screen`](https://pub.dev/packages/screen).
52 Specifically, the wakelock functionality was extracted into this plugin due to a lack of maintenance. 52 Specifically, the wakelock functionality was extracted into this plugin due to a lack of maintenance.
  53 +
  54 +If you want to contribute to this plugin, follow the [contributing guide](https://github.com/creativecreatorormaybenot/wakelock/blob/master/CONTRIBUTING.md).