Add steps for ensuring pre-commit hooks are installed (#416)

* Add steps for ensuring pre-commit hooks are installed

* Add .idea folder to gitignore

* Add steps for running tests and linters/formatters

* Retain trace logs on failure

Allows us to better debug why the tests just occasionally fail

* Add tracing to playwright tests

* Run tracing action regardless of test status

* Fix folder where test results will upload

* Use proper tests dir

* Actually turn on tracing and upload the resulting failed results

* Use jekyll serve detach command

I somehow missed that the command existed

* Add macos, jetbranins and vscode to gitignore

* Remove sleep fixture

Playwright has a built-in "slowmo" feature that would be easiest to use.
https://playwright.dev/python/docs/test-runners#cli-arguments

* Use standard python comparison operator

The `to_equal` doesn't seem to exist in playwright for python. There is a NodeJS equivalent, but there is no supported GenericAssertion equivalent for python

https://playwright.dev/docs/api/class-genericassertions

* Add explanation to test assertion

* Fix linting issues

* Pull upstream changes

* Use white theme for images

* Remake changes in CONTRIBUTING file

* Remove unneeded test-results folder

* Revert .gitignore

* Revert to base readme

* Use white theme to stay consistent

* Increase GH action job to 30 mins

* Run linter to fix linting errors

Author: dragid10

.github/workflows/conference.yml

@@ -55,19 +55,19 @@ jobs:
             automated pr
   add_comment:
     runs-on: ubuntu-latest
-    
+
     steps:
-    - name: Add comment to the issue
-      uses: actions/github-script@v6
-      if: ${{ github.event.issue.user.type != 'User' }} #adds comment only if the issue is created by a bot
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          const issueNumber = context.payload.issue.number;
-          const comment = "Automated issue, no action is required."
-          
-          github.issues.createComment({
-            ...context.repo,
-            issue_number: issueNumber,
-            body: comment
-          });
+      - name: Add comment to the issue
+        uses: actions/github-script@v6
+        if: ${{ github.event.issue.user.type != 'User' }} #adds comment only if the issue is created by a bot
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const issueNumber = context.payload.issue.number;
+            const comment = "Automated issue, no action is required."
+
+            github.issues.createComment({
+              ...context.repo,
+              issue_number: issueNumber,
+              body: comment
+            });

.github/workflows/playwright.yml

@@ -13,6 +13,7 @@ on:
 
 jobs:
   test:
+    timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

CONTRIBUTING.md

@@ -58,7 +58,15 @@ Follow these steps and note these guidelines to begin contributing:
 
   ![Bundle install terminal](/assets/images/bundle_install_terminal.png)
 
-- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
+- Afterwards, run the command `pip install -r requirements-dev.txt` to install the python dev dependencies.
+
+  ![Pip install terminal](/assets/images/pip_install_terminal.png)
+
+- Install the pre-commit hooks to automatically format the code before committing. Run the command `pre-commit install`:
+
+  ![Pre-commit install terminal](/assets/images/pre-commit_install_terminal.png)
+
+- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve --detach` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
 
   ![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
 
@@ -70,6 +78,32 @@ Follow these steps and note these guidelines to begin contributing:
 
   ![Running page](/assets/images/running_page.png)
 
-- Test your changes (create new tests as needed)
+### Testing Changes (create new tests as needed)
+
+- To run the test suites for the codebase
+
+  - Ensure the site is running locally with `bundle exec jekyll serve --detach`. This will run the server in the background, and any content changes will immediately reflect on the site.
+
+    ![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
+
+    - If you need to restart the server, you can run `pkill -f jekyll` to stop the server and then run `bundle exec jekyll serve --detach` to start the server again.
+
+  - Run all tests in the test-suite with the command `python3 -m pytest`:
+
+    ![Pytest terminal](/assets/images/pytest_run_terminal.png)
+
+### Pushing Changes
+
+- Run `pre-commit run --all` to ensure your code is formatted and linted correctly before pushing your changes.
+
+  ![Pre-commit run terminal](/assets/images/pre-commit_run_terminal.png)
+
+- Run `git commit -m "<Your commit message>"` to commit your changes.
+
+  ![Git commit terminal](/assets/images/git_commit_terminal.png)
+
+- Finally run `git push origin <your-branch-name>` to push your changes to your fork.
+
+  ![Git push terminal](/assets/images/git_push_terminal.png)
 
 - Once you’ve committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. Please ensure that you compare your feature branch to the desired branch of the repo you are supposed to make a PR to. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes in your development branch and update it. 🥳