-
Notifications
You must be signed in to change notification settings - Fork 13
Easy way to start contribute our project
Mateusz Ciapała edited this page Jul 28, 2022
·
3 revisions
- Open your IDE projects folder (Default located in user folder)
- Click Right Mouse Button(RMB) and choose open git bash here
- Clone remote repository by following command:
git clone https://github.com/Simple-as-Coding/tutoring-platform.git
Done. Your local repository has been created. Now you can navigate to repository root folder by cd tutoring-platform
All new features should be created on separated branch, if you are in root directory of tutoring-platform, follow these steps:
- Create new local branch by following command:
git checkout -b "your-branch-name" - You will be automatically moved to newly created branch. Now you can start working on your code.
Once you're done with creating new feature for application follow these steps to share it with other contributors.
- Push your branch to remote server, first push require setting up upstream so follow with this command:
git push -u origin "your-branch-name" - After your first push, the upstream is set up, so you can make another push or multiple pushes with following command:
git push - Once you're done with all changes, you can make your first pull request. Follow to your github account & navigate to our organization > tutoring-platform repository.
- Navigate to pull requests tab and click button called "Create new pull request".
- Select main branch as base and the one you want to merge as 2nd one.
- Fill topic with your functionality name, and add detailed description what it exactly does.
- At the end ensure yourself that everything is fine and click on "Create pull request" button.
- Now wait for Code Reviewer to merge your branch or inform you about required changes to be done before accepting it.
- Navigate our github repository page:
https://github.com/Simple-as-Coding/tutoring-platform - Fork our repository to your own github account using fork icon
- Open your IDE projects folder (Default located in user folder)
- Click Right Mouse Button(RMB) and choose open git bash here
- Clone remote repository by following command:
git clone https://github.com/<yourUsername>/tutoring-platform.git
Done. Your local repository has been created. Now you can navigate to repository root folder by cd tutoring-platform
All new features should be created on separated branch, if you are in root directory of tutoring-platform, follow these steps:
- Create new local branch by following command:
git checkout -b "your-branch-name" - You will be automatically moved to newly created branch. Now you can start working on your code.
Once you're done with creating new feature for application follow these steps to share it with other contributors.
- Push your branch to remote server, first push require setting up upstream so follow with this command:
git push -u origin "your-branch-name" - After your first push, the upstream is set up, so you can make another push or multiple pushes with following command:
git push - Once you're done with all changes, you can make your first pull request. Follow to your github account tutoring-platform forked repository.
- Navigate to pull requests tab and click button called "Create new pull request".
- Select Simple as Coding organization main branch as base and the one you want to merge from your github account as 2nd one.
- Fill topic with your functionality name, and add detailed description what it exactly does.
- At the end ensure yourself that everything is fine and click on "Create pull request" button.
- Now wait for Code Reviewer to merge your branch or inform you about required changes to be done before accepting it.