Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.5 KB
Raw

Contributing to tutorialdb

👍 🎉 First off, thanks for taking the time to contribute! 👍 🎉

The following are a set of guidelines for contributing to tutorialdb. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a Pull Request.

Table of Contents

  1. Getting Started
  2. Submitting Pull Requests

Getting Started

  • Make sure you communicate using GitHub issues while submitting a PR or reporting bugs.
  • You can use an appropriate label to label the issue.
  • Feel free to ask doubts by opening an issue.

Submitting Pull Requests

Before submitting a Pull Request, please make sure that there is a corresponding issue. If not, please provide a clear description, and title for your PR

Follow the steps given below while submitting a PR:

  1. Create your own branch (never commit to master).

    git checkout -b <branch_name>

  2. Setup the development environment by following the Installation instructions.

  3. Run the development server.

    python manage.py runserver

  4. Make your changes.

  5. Run the tests.

    python manage.py test

  6. Push your changes to your branch. Make sure to comment the SECRET_KEY and LOCAL_HOST variables.

  7. Create a Pull Request against the master branch.