Skip to content

Commit

Permalink
docs: updated info for better clarity
Browse files Browse the repository at this point in the history
- 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 <[email protected]>
  • Loading branch information
marchingon12 committed May 11, 2024
1 parent 6951009 commit 8986c3a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[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/

0 comments on commit 8986c3a

Please sign in to comment.