From 0d86f3ded68f1454c11a8f9e74e8525c84d39805 Mon Sep 17 00:00:00 2001 From: Nico Verbruggen Date: Sun, 18 Sep 2022 14:09:36 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README,=20contribution?= =?UTF-8?q?=20guidelines?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/contributing.md | 23 +++++++++++++++++++++++ .github/pull_request_template.md | 2 +- README.md | 2 +- 3 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 0000000..a1b1f4c --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,23 @@ +# Contribution Guidelines + +Thank you for your interest in contributing to PHP Monitor. + +I consider this project a bit of a nice side-project to my daily gig, so it is very much a personal affair where I love to tinker around. + +**While the code of the latest PHP Monitor release is public, many things are constantly in flux that may not be pushed to this repository yet.** + +I don't mean to be rude, but I don't want other people involved with the project beyond simply contributing a few small things here and there, as has been the case in the past. + +The extra mental overhead of having additional contributors to report to, whose code will need to be reviewed... it's a lot and it makes working on PHP Monitor less enjoyable for me. + +Plus, at this point, the majority of PHP Monitor's main functionality is also done. + +As a result, I may refer you to this file at some point. Again, I don't wish to be rude, but this general rule stands: + +**Making any changes in a fork and opening a pull request without opening an issue first will most likely result in your PR being closed without mercy.** + +To repeat, I am **not opposed** to small contributions and fixes, if they are **meaningful or insightful**. + +To learn more, please check out the [pull request template](/.github/pull_request_template.md) which contains more information about my contribution requirements. (This will also show up when you open a new PR.) + +Thank you for respecting this! \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 85293b0..3477d27 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,7 +16,7 @@ In short: It is usually best to *get in touch first* if you are making substanti ## About destination branches -Please keep in mind that `main` is reserved for the current code state of the latest release and should *never* be the destination branch unless a new release is happening. **Merge requests that target `main` will be closed without mercy.** +Please keep in mind that `main` is reserved for the current code state of the latest release and should *never* be the destination branch unless a new release is happening. **Pull requests that target `main` will be closed without mercy.** Usually, the best target is the stable `dev/x.x` branch that corresponds with the latest major version that is released. diff --git a/README.md b/README.md index 7575671..b5c73c8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ > **Note** -> If this software has been useful to you, I ask that you **please star the repository**, that way I know that the software is being used. Also, please consider leaving [a one-time donation](https://nicoverbruggen.be/sponsor) to support the project, as this is something I make in my free time. **Thank you!** ⭐️ +> If this software has been useful to you, I ask that you **please star the repository**, that way I know that the software is being used. Also, please consider [sponsoring](https://nicoverbruggen.be/sponsor) to support the project, as this is something I make in my free time. **Thank you!** ⭐️

PHP Monitor Logo