From c483f4d99dfc66feb28a4abf005842594bd57a2e Mon Sep 17 00:00:00 2001 From: tasosbeast Date: Tue, 28 Jan 2025 15:57:23 +0200 Subject: [PATCH 1/3] Add instructions for creating and pushing a branch --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 181fecb9..7bc85ca7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,8 @@ #### 👌🏾 How to fill a pull request template(Text) - Your Pull Request title should be like a commit message which should look like this -> `[prefix]: [what you did]` -[how to write what you did](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) -[how to pick which prefix to use](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index) + [how to write what you did](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) + [how to pick which prefix to use](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index) - Your PR description should have either `fixes`, `closes` with the issue number you worked on, for example, `fixes #123` or `closes #123` where #123 is the issue you worked on. It should not be `fixes issue #123` - Your PR description should also have the changes you did e.g added a new component, added a new image. @@ -51,6 +51,15 @@ - Take a look at the existing [Issues](https://github.com/Dun-sin/Whisper/issues) or [create a new issue](https://github.com/Dun-sin/Whisper/issues/new/choose)! - [Fork the Repo](https://github.com/Dun-sin/Whisper/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. +- Create and Push a Branch + - To create a new branch and switch to it: + ```bash + git checkout -b new-branch-name + ``` + - To push the branch to the remote repository: + ```bash + git push origin new-branch-name + ``` - Create a [Pull Request](https://github.com/Dun-sin/Whisper/compare) (PR), which will be promptly reviewed and given suggestions for improvements by the community. - Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR. From d12a1ccdf393cb03522bf9b39374cfcf19f9a049 Mon Sep 17 00:00:00 2001 From: tasosbeast Date: Tue, 28 Jan 2025 16:00:31 +0200 Subject: [PATCH 2/3] Docs: Add instructions for creating and pushing a branch --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 181fecb9..7bc85ca7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,8 @@ #### 👌🏾 How to fill a pull request template(Text) - Your Pull Request title should be like a commit message which should look like this -> `[prefix]: [what you did]` -[how to write what you did](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) -[how to pick which prefix to use](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index) + [how to write what you did](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) + [how to pick which prefix to use](https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index) - Your PR description should have either `fixes`, `closes` with the issue number you worked on, for example, `fixes #123` or `closes #123` where #123 is the issue you worked on. It should not be `fixes issue #123` - Your PR description should also have the changes you did e.g added a new component, added a new image. @@ -51,6 +51,15 @@ - Take a look at the existing [Issues](https://github.com/Dun-sin/Whisper/issues) or [create a new issue](https://github.com/Dun-sin/Whisper/issues/new/choose)! - [Fork the Repo](https://github.com/Dun-sin/Whisper/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. +- Create and Push a Branch + - To create a new branch and switch to it: + ```bash + git checkout -b new-branch-name + ``` + - To push the branch to the remote repository: + ```bash + git push origin new-branch-name + ``` - Create a [Pull Request](https://github.com/Dun-sin/Whisper/compare) (PR), which will be promptly reviewed and given suggestions for improvements by the community. - Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR. From 786a0cf1d627958a6b2aa735536268fd53998d5b Mon Sep 17 00:00:00 2001 From: tasosbeast Date: Tue, 28 Jan 2025 16:15:04 +0200 Subject: [PATCH 3/3] Add instructions for creating and pushing a branch --- CONTRIBUTING.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bc85ca7..7d7ce538 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,10 +14,21 @@ ### Pull Request guidelines - Don't create a pull request on an issue that doesn't exist, create an issue first and if the changes you are proposing are said to be okay, you can go ahead and create a pull request -- Don't work on the main branch, create your own branch by following the instructions [here](#-how-to-make-a-pull-request) +- Don't work on the main branch, create your own branch by following the instructions [here](#Creating-and-pushing-a-branch) - If you are working on the backend, share a screenrecording of your working software - don't create a PR for things outside of your issue's scope, it will lead to more work for the maintainers +### Creating and Pushing a Branch + +- To create a new branch and switch to it: + ```bash + git checkout -b new-branch-name + ``` +- To push the branch to the remote repository: + ```bash + git push origin new-branch-name + ``` + ### General guidelines - Do read the `readme.md` file @@ -51,15 +62,6 @@ - Take a look at the existing [Issues](https://github.com/Dun-sin/Whisper/issues) or [create a new issue](https://github.com/Dun-sin/Whisper/issues/new/choose)! - [Fork the Repo](https://github.com/Dun-sin/Whisper/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. -- Create and Push a Branch - - To create a new branch and switch to it: - ```bash - git checkout -b new-branch-name - ``` - - To push the branch to the remote repository: - ```bash - git push origin new-branch-name - ``` - Create a [Pull Request](https://github.com/Dun-sin/Whisper/compare) (PR), which will be promptly reviewed and given suggestions for improvements by the community. - Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.