CONTRIBUTING.md

Contributing Guidelines

You are Awesome! Thank you for your Interest in Contributing to this Project 🤗 For Contributions we strictly follow Github Flow.

Contents

• Setting Up the Project
• Contributing

Setting Up the Project

1. The Project works seamlessly on Python version 3.8.6

2. (Optional) Fork the Repository

3. Clone Your Forked copy/the original repo - git clone https://github.com/[YOUR-USERNAME]/Kitabe.git

4. Navigate to the directory of project - cd Kitabe/

5. (Optional) If you're intending to raise an MR else you can skip this step, Create a new branch - git checkout -b [branch_name]

6. Install requirements from poetry - poetry install

   • If you prefer the vanilla route poetry export -f requirements.txt --output requirements.txt --without-hashes skip to step (8)

7. Activate the environment - poetry shell

8. Open BookRecSystem/settings.py

9. Make Migrations - python manage.py migrate

10. python manage.py runserver - You're good to Go!!

📝 Raise an issue/start a discussion if you face difficulties while setting up the repo, we'll try to resolve it asap

Optional

• Setting up Google Auth

• Setting up SMTP

• Creating Superuser

Contributing

• Please go through Github Flow, if not already. :)

• Take up an Issue or Raise one.

• Discuss your proposed changes & Get assigned.

• If your changes are approved, do the changes in branch [branch_name].

• Run tests

• flake8, python manage.py test

• Fix if any test fails.

• Still in branch [branch_name].

• Stage and Commit only the required files.

• git push origin [branch_name] -u

• Browse here and create a PR from your branch with the appropriate required details.

• If your PR is accepted, it is automatically deployed once merged. :)

• That's it!

Tip: To keep your Fork Repo all branches updated with Upstream use this.