Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 1.43 KB

Starter.md

File metadata and controls

54 lines (43 loc) · 1.43 KB
Raw

  1. Fork this repository . (Using Fork option on the top right corner of the repository)

  2. Clone the forked repository in your local. (Use the command given below)

  git clone   https://github.com/CrewMates-Open-Source/EduHelp
  1. Navigate to the project directory.
cd  EduHelp
  1. Create a new branch.
git checkout -b <your_branch_name>

This setup is necessary while working with python scripts

  1. Setting up venv-environment in your local.
python3 -m venv env             (Create a separate Environment)

source env/bin/activate           (Activate the environment)

pip3 install -r requirements.txt  (Install's the dependencies)
  1. Now you are set and can run the python scripts with
python3 fileName.py

If you have installed any new dependency as a new feature add the package name to requirements.txt

  1. Make your changes in the sources code in the local repository.

  2. To Commit your changes. (Use git)

git commit -m "Message"
  1. Push your local branch to the remote repository.
git push -u origin <your_branch_name>
  1. Create a Pull Request!

a.) Go to your local repository where you make the changes and click on compare and pull requests. b.) Now, add a title of your work and description to your pull request that explains your precious effort.

Click on Compare and Pull Request.

Congratulations! boom Sit and relax, you've made your contribution to Crewmates project.