Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 2.07 KB
Raw

WELCOME TO rake_new2 : A PYTHON LIBRARY THAT HELPS IN EASIER KEYWORD EXTRACTION

Looking to contribute to this project ? All valid PRs are welcome.

CONTRIBUTING GUIDELINES FOR DEVSCRIPT WINTER OF CODE PARTICIPANTS

Follow these steps to set your local repository up and start contributing :

  1. Fork this repository.
  2. Clone the forked repository : git clone https://github.com/<YOUR_USERNAME>/rake_new2.git
  3. cd to the directory on your local machine : cd rake_new2
  4. Add upstream : git remote add upstream https://github.com/BALaka-18/rake_new2.git
  5. Checkout to the DWOC branch : git checkout DWOC-contributions
  6. That's it ! You're all set to go !

NOTE :

Make sure before you start making changes locally, you pull the code from the upstream everytime to make sure your local repository (remote) is even with the original repository (upstream). Command to pull code : git pull origin <BRANCH_NAME> (For now, the branch name will be DWOC-contributions)

BUT I'VE MADE THE CHANGES. WHAT NEXT ?

NOTE : MAKE SURE YOU'VE FOLLOWED THE FILE NAMING OR FOLDER NAMING CONVENTIONS

To make a PR, just follow these steps :

a. Stage your changes : ```git add .```

b. Commit your changes : ```git commit -m "<proper commit message>"```

c. Push them to your forked repository : ```git push origin DWOC-contributions```

d. Go to your forked repository and refresh, you'll receive a prompt to create a PR. Make sure you write a proper PR description, else, your PR will be rejected.

e. Wait for the maintainer to review your PR.

HAPPY CONTRIBUTING !!