Skip to content

README.md

Latest commit

 

History

History
45 lines (34 loc) · 1.29 KB

README.md

File metadata and controls

45 lines (34 loc) · 1.29 KB

EV-Slot-Booking-Backend

Django project for EV Slot Booking website

Contribution Guidelines

  1. Fork this repo
  2. Clone your forked repo git clone
  3. Add the main repo as upstream git remote add upstream {url}
  4. Make your changes and push to your(forked) repo.
  5. Create a pull request from github to main repo.

To get some changes from main repo git pull upstream

NOBODY SHOULD DIRECTLY PUSH TO THE MAIN REPO.

There will be 2 branches

  • main
  • dev

Apart from the 2 branches above you can create as many branches as you want.

NOBOBY SHOULD MAKE PULL REQUEST TO MAIN BRANCH. All changes should be made to dev.

Folder structure

 |- .env.example (contains the sample format for the .env file)
 |- <django_project_name>
 |- <django_app_1>
 |- <django_app_2>

OR

<django_project_name>
 |- .env.example (contains the sample format for the .env file) 
 |- <django_project_name>
 |- <django_app_1>
 |- <django_app_2>

Apart from this you can create any folders if you want.

Important Notes

  • Commits and pull requests should be made with proper descriptive messages.
  • Do NOT commit or push any sensitive info such as passwords or emails in the code. Such data should go in the .env file, and a sample empty entry for the same should be added for the same in .env.example