Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
If you don't have git on your machine, install it.
- Take a look at the Existing Issues or create your own Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Fork the Repo and create a Branch for any Issue that you are working upon.
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
- Add Screenshots to help us know what this Script is all about.
- Fork and Clone the repository using-
git clone https://github.com/kavania2002/MobiMart.git
- Create virtual environment-
python -m venv env
env\Scripts\activate
3. Install dependencies using-
pip install -r requirements.txt
If you have python2 and python3 installed you need to specify python3 by using command:
python3 -m pip install -r requirements.txt
- Headover to Project Directory-
cd mobimart
- Make migrations using-
python manage.py makemigrations
If you have python2 and python3 installed you need to specify python3 by using command:
python3 manage.py makemigrations
- Migrate Database-
python manage.py migrate
- Create a superuser-
python manage.py createsuperuser
- Run server using-
python manage.py runserver
- Push Changes-
git add .
git commit -m "<your commit message>"
git push
-
Create a PR !
-
Congratulations! Sit and relax, you've made your contribution to MobiMart project.
-
🏆 After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.***
- Use the present tense (example: "Add feature" and not "Added feature")
- Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
- Limit the first line (also called subject line) to 50 characters or less
- Capitalize the subject line
- Separate subject from body with a blank line
- Do not end the subject line with a period
- Wrap the body at 72 characters
- Use the body to explain what, why, vs, and how
- Reference issues and pull requests liberally after the first line
For more detailed reference to the above points, refer here: https://chris.beams.io/posts/git-commit.
For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.
