This is the repo for the URL Shortner Website of DSC Thapar Institute of Engineering and Technology, Patiala , Punjab. Kindly go through the entire README.md for getting familiar with contribution steps.
- Create a fork of this repo.
- Clone your fork of your repo on your pc.
- Add Upstream to your clone
- Every change that you do, it has to be on a branch. Commits on master would directly be closed.
- Make sure that before you create a new branch for new changes,syncing with upstream is neccesary.
- Write clear meaningful git commit messages (Do read this).
- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
- When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)
- Make sure that your system has pre-commit install and you run it before pushing code on the PR. These are the steps to follow -
pip install pre-commitpre-commit install
- Failing to do so will result in failure of Travis tests.
- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
- Use only
npm add package_nameto add new packages to thepackage.json.