This repository serves to be a landing place for all the task related code submissions for onboarding to Bitshift Open Community.
For code submissions, we would like to follow a set of Contribution Guidelines (like any other Open Source Organization), which would in turn make students aware about the importance of Contribution Guidelines in Open Source Projects.
We would thus encourage the students to follow the below mentioned points:
- Fork the bitshiftlabs/onboarding repository to your account and clone it.
- Add upstream as bitshiftlabs/onboarding repo and perform
fetch. You may use the following commands for your reference.
$ git clone https://github.com/<your-username>/onboarding.git
$ cd onboarding
$ git remote add upstream https://github.com/bitshiftlabs/onboarding.git
$ git fetch --all- ⭐ Switch to the branch which matches your first name, ex: switch to branch
vivekif your name isVivek Nigam. You will be making all the commits to this branch itself.
(For your convenience you may create additional branches with any name on your forked repo and merge them with your 'named branch' later)
- Keep a folder structure which is maintainable. One suggested structure is given below:
vivek
|-Task 1
|-Task 2
|-Task 3
|- Well of course, this is just a trivial suggestion and you are not pushed to use it strictly. You can freely use other better ways to organize your project :)
- ⭐ Make a Pull Request from
<your-username>/onboarding:<named-branch>→bitshiftlabs/onboarding:<named-branch>after each task, so that there can be a smooth workflow for code-reviews. - Code reviews are an important part of an open-source organization environment, so 🥮 Brownie Points for reviewing other peer's code! Hint: You may find the code in their 'named branch'.
Enough said! It's time to dive into the actual exciting stuff.
Anything else on your mind? Do let us know by mailing us here.