%3D-backend-yellow.svg){kind=icon}
This repo was created for students to submit their homeworks for review.
Install and use yarn
instead of npm.
-
fork this repository
-
clone your fork to your local machine:
git clone https://github.com/YOUR_USERNAME/nodejs-2019-homeworks.git -
add this repository as an upstream:
git remote add upstream https://github.com/kottans/nodejs-2019-homeworks.git -
for every new task you're gonna submit, in your local repository:
git checkout master && git pull upstream master && git push originto update your fork from the base repogit checkout masterand then create new branch, name it according to task performed (aka feature branch):git checkout -b port-sniffer. In this example feature branch is namedport-sniffer. Make sure you never commit intomasterdirectly or you may face code conflicts.- add a folder with your github name under
submissions(if you haven't yet) - under your name folder, add a folder with task name and put your code in the folder
See example file structure you are expected to have below:
-
make sure your code conforms to code quality rules
-
if your project has dependencies (i.e. its own
package.json) then complete the following in order to pass CI checks:- put all required files in your project directory only
- in the root
package.jsonadd a build integration script (right beforepostinstallscript) following the template:"install:<your-github-name>/<your-project-name>": "cd ./path/to/your/project && yarn"
-
make pull-request to this repository following these steps:
- checkout the relevant feature branch:
git checkout port-sniffer(in this example feature branch is calledport-sniffer) - commit your changes if any to the feature branch
- checkout
masterbranch:git checkout master - pull latest changes from upstream
masterbranch:git pull upstream master - rebase your feature branch onto
master:git checkout port-sniffer && git rebase master - resolve merge conflicts if there are any
- push feature branch to your remote repository:
git push --set-upstream origin port-sniffer - make pull-request from your repository to this repository via GitHub web-interface
- checkout the relevant feature branch:
-
post a link to your subtask PR in the BE Questionarium chat and ask mentors for a code review
- wait for review from course mentors
- if necessary, make changes, until your code will be approved and merged
- once the code review phase successfully finished
and you have an approval from one of the mentors
add to your
kottans-backend/README.mda link to subtask code base and a note sayingReviewed and approved by @<mentor>(use mentor's github username) - list your reflections on this subtask (what was new to you, what surprised you, what you intend to use in future)
-
when any changes are required (whether it si your own decision or requested by a mentor)
- checkout your feature branch before any code base updates:
git checkout <feature-branch-name> - once committed the changes and ready to update your pull request just
git push origin; GitHub will track your new commits and update the pull request
- checkout your feature branch before any code base updates:
