From 8986c3aff9c74608ca3351c403dfb73af83e4989 Mon Sep 17 00:00:00 2001 From: Austin Hornhead Date: Sat, 11 May 2024 21:29:58 +0000 Subject: [PATCH] docs: updated info for better clarity - included options in the pull_request_template.md for simplified selection - renamed original pull_request_template.md to general_template.md - added info on conventional commits and available PR templates Signed-off-by: Austin Hornhead --- ...pull_request_template.md => general_template.md} | 0 .github/pull_request_template.md | 3 +++ CONTRIBUTING.md | 13 +++++++++++-- 3 files changed, 14 insertions(+), 2 deletions(-) rename .github/PULL_REQUEST_TEMPLATE/{pull_request_template.md => general_template.md} (100%) create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/general_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/general_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7b9679b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,3 @@ +Please go the the `Preview` tab and select the appropriate sub-template: +- [General PR](?expand=1&template=general_template.md): for all other PRs, including bug fixes, adding features etc. +- [Translation PR](?expand=1&template=translations_template.md): specifically to be used for translation PRs \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5fbd5c..fc76373 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,11 +22,20 @@ If you'd like to request a feature you deem necessary and useful, open a new Git If you wish to contribute to the project by submitting code directly, please first leave a comment under the relevant issue or file a new issue, describe the changes you are about to make. -To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment, or ask the issue to be assigned to yourself. +As per our project's guidelines, we adhere to [conventional commits][conv-commits]. Therefore, it's expected that all PRs align with this convention. Should a PR not meet these standards, we'll kindly request a review and revision. + +Please use the provided Pull Request templates according to your needs. Currently, there are two to choose from: +- [General PR](./.github/PULL_REQUEST_TEMPLATE/pull_request_template.md): for all other PRs, including bug fixes, adding features etc. +- [Translation PR](./.github/PULL_REQUEST_TEMPLATE/translations_template.md): specifically to be used for translation PRs + +> [!TIP] +> +> To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment, or ask the issue to be assigned to yourself. ## Building From Source Fork this project, import and compile it with the latest version of [Android Studio](https://developer.android.com/studio/). [issues]: https://github.com/Pool-Of-Tears/GreenStash/issues/new/choose -[feature-req]: https://github.com/Pool-Of-Tears/GreenStash/issues/new?assignees=&labels=enhancement&projects=&template=--feature-request.yml&title=%5BFeature+Request%5D \ No newline at end of file +[feature-req]: https://github.com/Pool-Of-Tears/GreenStash/issues/new?assignees=&labels=enhancement&projects=&template=--feature-request.yml&title=%5BFeature+Request%5D +[conv-commits]:https://kapeli.com/cheat_sheets/ \ No newline at end of file