Merge pull request #635 from jhuopensource/release/v5.3.2

Release/v5.3.2

.github/PULL_REQUEST_TEMPLATE.md

@@ -1 +1,3 @@
-### Description
+## Description
+
+## Change Log

.github/workflows/black.yml

@@ -5,12 +5,10 @@ on:
     branches:
       - prod
       - develop
-      - feature/enhance-custom-events
   pull_request:
     branches:
       - prod
       - develop
-      - feature/enhance-custom-events
 
 jobs:
   lint:

.github/workflows/semesterly.yml

@@ -5,12 +5,10 @@ on:
     branches: 
       - prod
       - develop
-      - feature/enhance-custom-events
   pull_request:
     branches: 
       - prod
       - develop
-      - feature/enhance-custom-events
 
 jobs:
   build:

.github/workflows/tslint.yml

@@ -5,12 +5,10 @@ on:
     branches:
       - prod
       - develop
-      - feature/enhance-custom-events
   pull_request:
     branches:
       - prod
       - develop
-      - feature/enhance-custom-events
 
 jobs:
   lint:

dev/gotchas.md

@@ -0,0 +1,13 @@
+* You need to have secrets for parsing courses and logging in, please ask the current
+  team lead if you do not have these.
+
+* If you're working with Facebook login, you need to be on HTTPS. This means using
+  `https://jhu.sem.ly` instead of `http://localhost:8000`. Notice that there's no port
+  number in the HTTPS link. You might also have to click past `Your connection in not
+  private` by going to `Advanced` and then `Proceed to jhu.sem.ly (unsafe)`.
+
+* `ImmatureSignatureError` - check if your timezone is correct with `date`. You might
+  need to reset it with `sudo hwclock -s`.
+
+* Sometimes your docker image is just wrong for no reason; you can completely wipe it
+  with `docker system prune -a` and then `docker-compose up`.

dev/hacksessions.md

@@ -0,0 +1,33 @@
+# Hack Sessions and Check-ins
+
+## Week.ly Check-in ~ 10 minutes
+
+The check-in is just a time for you to notify us of your progress or anything that’s stopping you from making progress. It’s expected that you are active on the team Slack during this time (no Zoom unless you need to talk about something). All you have to write or tell us about is:
+
+1. What you’ve done so far
+2. What you will do next
+3. What’s blocking you
+
+## Week.ly Hack Session ~ 30-90+ minutes
+
+Every Thursday at 4pm, we’ll meet in Malone to discuss our progress and next steps. In-person is preferred but virtual is permitted.
+
+### Check-in ~ 10 minutes
+
+1. What you’ve done so far
+2. What you will do next
+3. What’s blocking you
+
+### Self-Retrospection (unshared) ~ 5 minutes
+
+1. What did I do well?
+2. What can I do better?
+3. Actions
+
+### Team-Retrospection (shared) ~ 15 minutes
+
+1. What did we do well?
+2. What can we do better?
+3. Actions
+
+### Team Activities or Resolving/Debugging Issues ~ 0-60+ minutes

dev/onboarding.md

@@ -0,0 +1,58 @@
+# Onboarding
+
+**Welcome to the Semester.ly Team!**
+
+Congratulations on making it into the team and we are glad to have you join us. Detailed
+in this guide is everything I want you to go through before we can get you started with
+working on the team.
+
+## Getting Paid
+
+You should be hearing from Ali Soylu @ JHIT about getting put on payroll. This is a
+process that might take a while, especially if you've never worked at JHU before. While
+I think it'd be ideal for you to start tracking your hours and log them later when you
+can, it's up to you whether you want to start working when you know you'll actually get
+paid.
+
+Logging hours is done through our
+[JIRA](https://jira.sset.jhu.edu/jira/projects/SEM/issues/SEM-175?filter=allopenissues);
+click on the `More` dropdown and click `Log Time`. Enter a description and the amount of
+time you've worked to log time for the day. You'll also have to *submit your timesheet*
+when the current week passes. You can do this by selecting `Tempo` in the menu bar and
+clicking on `My Work`. From there, you can select the `Current Period` dropdown and
+click `Submit`.
+
+You should log all hours you work for Semester.ly, including hours you spend learning
+new material for the job.
+
+## Getting Started
+
+Please visit the [docs](https://semesterly-v2.readthedocs.io/en/latest/setup.html) for
+how to set up VSCode with Semester.ly. It's actually quite a difficult setup process, so
+please follow the directions carefully and ask for help if you run into issues.
+
+Once you have completed that, you should have your own repository in addition to a
+remote to the upstream repository. Make sure you are on the `develop` branch and create
+a new branch called `onboarding/your-name`
+
+```bash
+git checkout develop
+git checkout -b onboarding/your-name
+```
+
+You should now edit the [read the docs file](./readthedocs.md) and answer the questions
+there. These questions provide some useful information that you should know while
+developing at Semester.ly.
+
+Once you have answered all of the questions, create a pull request (PR) and I will give
+you a review to ensure you've got the important parts. You can then delete your
+`onboarding` branch.
+
+## Moving Forwards
+
+Before you get started on team projects, I would like to assign you a small task and
+work with you on that task to help you with any first issues that you might come across
+while developing for Semester.ly. Notify me when you've reached this point and we will
+discuss what kind of a task we can work on together. In the meantime, please take a look
+at the other documents in this directory for other information you might be interested
+in.

dev/projects.md

@@ -0,0 +1,38 @@
+# Starting New Projects
+
+## Creating The Project
+
+1. Begin by going to our [GitHub
+   repository](https://github.com/jhuopensource/semesterly/projects) under projects and
+   if your project does not already exist, hit `New project`.
+
+2. Give your Project an appropriate name and description, and then for `Project
+   template` select 'Automated kanban with reviews`. This should show you your project
+   board.
+
+3. From there, in `To do`, remove the automatically generated cards. In here, you can
+   add cards and convert them into issues. If you already have some issues that you want
+   to note down, this is where you can make them.
+
+
+## Creating a Feature Branch
+
+**Note:** You do not have to do this if you are the only one working on the branch. Just
+create your own local branch and create a PR there.
+
+1. Make sure you are on the `develop` branch in the [Github
+   repository](https://github.com/jhuopensource/semesterly). Click on the dropdown where
+   you can search or create a branch, and create a branch from here called
+   `feature/your-feature-name`.
+
+2. In your editor now, `git fetch` and `git checkout feature/your-feature-name` to
+   switch to the branch you just created.
+
+3. For each file in [.github/workflows/], you want to add your branch to the `branches`
+   section. This is to enable the linters and automated tests workflow to run on your
+   newly created branch.
+
+4. Commit the change and create a PR; You will have to set the base repository to
+   `jhuopensource` and the base branch to `develop`. Everyone can now checkout the PR
+   and branch off the feature branch to begin work.
+

dev/readthedocs.md

@@ -0,0 +1,31 @@
+# Documentation Quiz
+
+Please visit the [docs](https://semesterly-v2.readthedocs.io/en/latest/index.html) and
+answer the following questions.
+
+1. What is the command I run to get the courses from Fall 2021?
+
+2. How do I then load those courses into my database?
+
+3. How do I get a terminal running in my docker container?
+
+4. Where do I store data I don’t want to commit?
+
+5. What is our stack?
+
+6. What branch do I create a new branch off of when developing?
+
+7. If I want to start on a feature called myfeature, what should the branch name be?
+
+   What about if I want to refactor myreducer?
+
+8. What is the preferred format for commit messages?
+
+9. What linters do we run against our code?
+
+10. What is the max line length set to?
+
+11. What is a FeatureFlowView?
+
+
+When you are done answering the questions, create a PR for a discussion of your answers.

docs/advancedconfig.rst

@@ -24,18 +24,37 @@ With this extension, you can set your default formatter (black) and default lint
 (pycodestyle). If you choose to set pycodestyle as your linter, be sure to change
 max-line-length to 88.
 
-2. `ESLint <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>`_.
+2. `JavaScript + TypeScript
+<https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-next>`_.
+TypeScript support for development.
+
+3. `ESLint <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>`_.
 As one of our checks requires ESLint to be satisfied, this will save you some time.
 
-3. `Prettier <https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode>`_.
+4. `Prettier <https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode>`_.
 Formats JS/TS for you. You will want to set Prettier as your default formatter, and
 we suggest you set Format Document On Save to be on in your VSCode preferences.
 
-4. `IntelliCode <https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode>`_.
+5. `IntelliCode <https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode>`_.
 Provides useful suggestions.
 
-5. `GitHub Copilot <https://marketplace.visualstudio.com/items?itemName=GitHub.copilot>`_.
-Can often write your code for you, but be sure to double check it.
+6. `GitHub Copilot
+<https://marketplace.visualstudio.com/items?itemName=GitHub.copilot>`_. Can often
+write your code for you, but be sure to double check it.
+
+7. `Bookmarks
+<https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks>`_. Lets
+you mark places in code that you want to revisit.
+
+8. `Rewrap <https://marketplace.visualstudio.com/items?itemName=stkb.rewrap>`_. It helps
+with wrapping text for you when editing documentation or code comments.
+
+9. `Sourcery <https://marketplace.visualstudio.com/items?itemName=sourcery.sourcery>`_.
+Sometimes will help you write cleaner Python code.
+
+10. `SpellChecker 
+<https://marketplace.visualstudio.com/items?itemName=swyphcosmo.spellchecker>`_.
+Helps you find typos in documentation.
 
 
 Overriding/Setting Secrets

docs/contributing.rst

@@ -20,9 +20,11 @@ We follow the `Gitflow workflow
 <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`_; our
 main branch is ``prod``, and our develop branch is ``develop``. The general gist is that
 for anything new, you want to branch off of ``develop`` and name your branch
-``feature/your-branch-name``. In the case you need to fix something that was just
-released, and it needs to go straight to production, then branch off of ``prod`` and
-name your branch ``hotfix/your-branch-name``.
+``feature/your-branch-name``. Two other conventions we have is for bug fixes we use
+``fix/your-branch-name``, and for refactoring we use ``refactor/your-branch-name``. In
+the case you need to fix something that was just released, and it needs to go straight
+to production, then branch off of ``prod`` and name your branch
+``hotfix/your-branch-name``.
 
 To stay up to date with ``upstream/develop``, you'll want to ``git pull`` whenever you're
 starting a new branch. You may need to ``git fetch upstream`` first.
@@ -50,6 +52,15 @@ After you've made edits, git add your files, then commit. One way to do this:
     git commit -m "Topic: Message"
     git push --set-upstream origin your-branch-name
 
+.. note::
+    It is preferred that you follow the commit message convention of "Topic: Message". 
+    This helps when we are browsing through commits so we can quickly identify what each
+    commit was about. 
+    **Messages should be in the imperative mood**, as if you're telling someone what to
+    do. If it helps, you are encouraged to include the how/why - 
+    *"Evaluation list: Duplicate state to avoid modifying redux state"*.
+    Furthermore, try to keep commits to "one" change at a time and commit often. 
+
 From here, you should be prompted to create a new pull request (PR). Ctrl + Left Click to
 open the link. From there, add a short description on what your PR does and how/why you
 did it, and then create the PR. If your PR is ready for review, add a reviewer as well.

docs/frontend.rst

@@ -198,8 +198,6 @@ General Components
 +-------------------------------+--------------------------------------------------+--------------------------+
 |``social_profile.jsx``         | .. image:: components/social_profile.png         |                          |
 +-------------------------------+--------------------------------------------------+--------------------------+
-|``sort_menu.jsx``              | .. image:: components/sort_menu.png              |                          |
-+-------------------------------+--------------------------------------------------+--------------------------+
 |``terms_of_service_banner.jsx``| .. image:: components/terms_of_service_banner.png|                          |
 +-------------------------------+--------------------------------------------------+--------------------------+
 |``terms_of_service_modal.jsx`` | .. image:: components/terms_of_service_modal.png |                          |

docs/learning.rst

@@ -36,7 +36,7 @@ over the tech industry by companies like Spotify, Instagram, YouTube, and DropBo
 tutorial. It is top notch! The official documentation can be found at the same url and
 provides high quality information about how to build with this modern web framework. For
 example, here's the documentation on `making queries with Django
-<https://docs.djangoproject.com/en/3.2/topics/db/queries/>`_ 
+<https://docs.djangoproject.com/en/3.2/topics/db/queries/>`_.
 
 
 Learning React/Redux

helpers/test/data.py

@@ -19,12 +19,6 @@ def get_default_tt_request():
         "optionCourses": [],
         "preferences": {
             "try_with_conflicts": False,
-            "sort_metrics": [
-                {"metric": "days with class", "selected": False, "order": "least"},
-                {"metric": "number of conflicts", "selected": False, "order": "least"},
-                {"metric": "time on campus", "selected": False, "order": "least"},
-                {"metric": "course rating stars", "selected": False, "order": "most"},
-            ],
         },
         "try_with_conflicts": False,
         "school": "uoft",