Merge branch 'develop' into jwt-flask-extended-bump

.all-contributorsrc

@@ -0,0 +1,66 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "contributorsPerLine": 7,
+  "contributorsSortAlphabetically": false,
+  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
+  "skipCi": true,
+  "contributors": [
+    {
+      "login": "isabelcosta",
+      "name": "Isabel Costa",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11148726?v=4",
+      "profile": "https://isabelcosta.github.io/",
+      "contributions": [
+        "maintenance"
+      ]
+    },
+    {
+      "login": "vj-codes",
+      "name": "Vaishnavi Joshi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/60894542?v=4",
+      "profile": "https://github.com/vj-codes",
+      "contributions": [
+        "maintenance",
+        "design"
+      ]
+    },
+    {
+      "login": "epicadk",
+      "name": "Aditya Kurkure",
+      "avatar_url": "https://avatars.githubusercontent.com/u/56596662?v=4",
+      "profile": "https://github.com/epicadk",
+      "contributions": [
+        "code",
+        "maintenance",
+        "test"
+      ]
+    },
+      "login": "devkapilbansal",
+      "name": "Kapil Bansal",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42766576?v=4",
+      "profile": "https://github.com/devkapilbansal",
+      "contributions": [
+        "code",
+        "maintenance",
+        "test"
+      ]
+    },
+    {
+      "login": "gaurivn",
+      "name": "Gauri V. Nair",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48416306?v=4",
+      "profile": "https://github.com/gaurivn",
+      "contributions": [
+        "code",
+        "maintenance"
+      ]
+    }
+  ],
+  "projectName": "mentorship-backend",
+  "projectOwner": "anitab-org",
+  "repoType": "github",
+  "repoHost": "https://github.com"
+}

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    # omit everything in the tests directory
+    tests/*

.flake8

@@ -0,0 +1,13 @@
+[flake8]
+ignore =
+    # W503: line break before binary operator
+    # ignored as it creates inconsistency with black
+    W503,
+    # E501: line too long (> 88 characters)
+    # ignored till a final decision is made on what to do with long comments
+    E501,
+    # C901: variable or function name is too complex (> 18 characters)
+    # ignored till someone simplifies the names
+    C901
+max-line-length = 88
+max-complexity = 18

.github/CONTRIBUTING.md

@@ -7,16 +7,16 @@
 * When developing a new feature, include at least one test when applicable.
 * When submitting a PR, please follow [this template](PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR).
 * When submitting a PR with changes to user interface (e.g.: new screen, or an email template), please add screenshots to the PR description.
-* When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history). 
+* When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history).
 * When writing in-code documentation as Docstrings, please follow [this guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings).
-* When creating an issue to report a bug in the project, please follow our [bug_report.md](ISSUE_TEMPLATE/bug_report.md) template.
+* When creating an issue to report a bug in the project, please follow our [bug_report.md](https://github.com/anitab-org/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) template.
 
 ## General Guidelines
 
 * If you’re just getting started work on an issue labeled “First Timers Only” in any project. Additional resources are available on our [website](http://www.systers.io).
-* In an active repository (not an archived one), choose an open issue from the issue list, claim it in the comments, and a maintainer will assign it to you.  
+* In an active repository (not an archived one), choose an open issue from the issue list, claim it in the comments, and a maintainer will assign it to you.
 * After approval you must make continuous notes on your progress in the issue while working.  If there is not at least one comment every 3 days, the maintainer can reassign the issue.
 * Create a branch specific to the issue you're working on, so that you send a PR from that branch instead of the base branch on your fork.
-* If you’d like to create a new issue, please go through our issue list first (open as well as closed) and make sure the issues you are reporting do not replicate the existing issues. 
+* If you’d like to create a new issue, please go through our issue list first (open as well as closed) and make sure the issues you are reporting do not replicate the existing issues.
 * Have a short description on what has gone wrong (like a root cause analysis and description of the fix), if that information is not already present in the issue.
 * If you have issues on multiple pages, report them separately. Do not combine them into a single issue.

.github/PULL_REQUEST_TEMPLATE.md

@@ -41,7 +41,7 @@ Fixes # [ISSUE]
 
 **Code/Quality Assurance Only**
 
-- [ ] My changes generate no new warnings 
+- [ ] My changes generate no new warnings
 - [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes

.github/config.yml

@@ -0,0 +1,54 @@
+# Configuration for welcome - https://github.com/behaviorbot/welcome
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+
+# Comment to be posted to on first time issues
+newIssueWelcomeComment: |
+  Hello there!👋 Welcome to the project!💖
+
+  Thank you and congrats 🎉 for opening your very first issue in this project.
+  AnitaB.org Open Source is an inclusive community, committed to creating a safe and positive environment 🌸  Please follow our [Code Of Conduct](https://github.com/anitab-org/mentorship-backend/blob/develop/docs/code_of_conduct.md) 🙌
+  You can learn more about the community on [our website](https://anitab-org.github.io/) and [documentation repository](https://github.com/anitab-org/documentation#readme).
+
+  You may submit a PR on the same if you like!
+  Please follow our [Commit Message Style Guide](https://github.com/anitab-org/mentorship-backend/wiki/Commit-Message-Style-Guide) and [Coding Standards](../docs/coding_standards.md) while sending PRs.
+  If you want to report a bug 🐞, please follow our [bug_report.md](https://github.com/anitab-org/mentorship-backend/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md) template. Please make sure you include steps to reproduce it and be patient we will get back to you as soon as we can 👀
+
+
+  Also, feel free to join us on [AnitaB.org Open Source Zulip Community](https://anitab-org.zulipchat.com/) 🤝 We have different streams for each active repository for discussions.👩🏻‍💻🧑🏻‍💻
+  For mentorship-backend, join [#mentorship-system](https://anitab-org.zulipchat.com/#narrow/stream/222534-mentorship-system) stream! Hope you have a great time here :)
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: |
+  Hello there!👋 Welcome to the project!💖
+  Thank you and congrats 🎉 for opening your first PR on this project.✨
+  Please ensure your Pull Request meets the [Commit Message Style Guide](https://github.com/anitab-org/mentorship-backend/wiki/Commit-Message-Style-Guide).
+  We will review it soon! Until then you can check out the [`README.md`](../README.md) for more details on it.
+
+  AnitaB.org Open Source is an inclusive community, committed to creating a safe and positive environment 🌸 Please follow our [Code Of Conduct](https://github.com/anitab-org/mentorship-backend/blob/develop/docs/code_of_conduct.md).
+
+  Feel free to join our community at [AnitaB.org Open Source Zulip Community](https://anitab-org.zulipchat.com/) to be kept up to date with our projects discussions and community activities.
+  Hope you have a great time here :)
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+
+# Comment to be posted to on pull requests merged by a first time user
+firstPRMergeComment: |
+  Woohoo!🎊 Congrats on merging your first contribution to [mentorship-backend](https://github.com/anitab-org/mentorship-backend)!✨
+  Your code is officially a part of AnitaB.org Open Source now!! Time for a celebration 🙌🎉⚡️
+  Feel free to explore more on this project.🤗
+  Join us on [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com/). 🤝
+  We have different streams for each active repository for discussions. 👩🏽‍💻🧑🏼‍💻
+  Do join our weekly check-in stream to share your weekly goals and the awesome work you did here.😃
+
+  <details>
+  <summary><b>Now that you've completed this, you can help someone else take their first step!</b></summary>
+  <p>Check out projects stream on Zulip and the `First Timers Only` issues to check if someone needs help to figure out their problem or need some feedbacks. Reach out and be encouraging and friendly! 😄 🎉</p>
+  <p>People often get stuck at the same steps, so you might be able to help someone get unstuck, or help lead them to some documentation that'd help. Reach out and be encouraging and friendly! 😄 🎉 </p>
+  <p>Create a welcoming issue for someone else or review their pull requests! 😄 🎉 </p>
+  </details>
+
+
+# It is recommended to include as many gifs and emojis as possible!

.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+name: documentation
+
+on:
+  pull_request:
+    branches: [develop]
+  push:
+    branches: [develop]
+
+jobs:
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          cd docs/
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "gh-actions"
+          cd docs/
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run deploy