Skip to content

Commit f18243a

Browse files
committed
Update references to scripts
1 parent 04d9402 commit f18243a

File tree

3 files changed

+47
-25
lines changed

3 files changed

+47
-25
lines changed

GHC-Open-Source-Day.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ git checkout -b your-branch-name
7676

7777
4. **Address review comments until all reviewers give LGTM ('looks good to me').**
7878
* Resolve any merge conflicts that arise.
79-
* Run `bash scripts/start.sh` and play with the dev server in order to make sure that everything still works, and also to install any new dependencies that have been added since you last synced the repo.
79+
* Run `python -m scripts.start` and play with the dev server in order to make sure that everything still works, and also to install any new dependencies that have been added since you last synced the repo.
8080
* WARNING: Do not make changes using the online GitHub editor -- this bypasses lint/presubmit checks, and will cause the code on GitHub to diverge from the code on your machine. Always make commits locally, and then push to GitHub.
8181

8282
5. Tidy up! After the PR status has changed to "Merged", delete the feature branch from both your local clone and the GitHub repository
@@ -107,16 +107,38 @@ Starter project
107107
* [Project 8: Improve unit tests](#project-8-improve-unit-tests)
108108

109109
Easy
110-
* [Project 2: Create toasts for success messages](#project-2-create-toasts-for-success-messages)
111-
* [Project 7: Improve linter checks](#project-7-improve-linter-checks)
112-
* [Project 9: Writing Selenium tests for interactions](#project-9-writing-selenium-tests-for-interactions)
113-
* [Project 10: Expose "upload exploration" functionality in admin page](#project-10-expose-upload-exploration-functionality-in-admin-page)
114-
* [Project 13: Find ways to make the audio translation tab interface clearer](#project-13-find-ways-to-make-the-audio-translation-tab-interface-clearer)
115-
* [Project 14: Feedback threads in feedback tab do not reorder by recent updates in real time](#project-14-feedback-threads-in-feedback-tab-do-not-reorder-by-recent-updates-in-real-time)
116-
* [Project 16: Cross Browser Compatibility Improvement - Translation console for Safari](#project-20-cross-browser-compatibility-improvement---translation-console-for-safari)
117-
* [Project 17: Improving oppia.org experience on mobile](#project-17-improving-oppiaorg-experience-on-mobile)
118-
* [Project 18: Accessibility Improvements - Tabbing Order](#project-18-accessibility-improvements---tabbing-order)
119-
* [Project 19: Accessibility Improvements - Fixing Contrast in Image Region Selectors](#project-19-accessibility-improvements---fixing-contrast-in-image-region-selectors)
110+
- [Getting Ready for Open Source Day](#getting-ready-for-open-source-day)
111+
- [Table Of Contents](#table-of-contents)
112+
- [How To Get Started](#how-to-get-started)
113+
- [Setting Up Before Open Source Day](#setting-up-before-open-source-day)
114+
- [Sign the CLA](#sign-the-cla)
115+
- [Create a GitHub account](#create-a-github-account)
116+
- [Install Oppia on your machine](#install-oppia-on-your-machine)
117+
- [Join the Gitter channel](#join-the-gitter-channel)
118+
- [Some useful links](#some-useful-links)
119+
- [Making A Code Change](#making-a-code-change)
120+
- [What to do when you are stuck](#what-to-do-when-you-are-stuck)
121+
- [List of Projects](#list-of-projects)
122+
- [Project List](#project-list)
123+
- [Project 1: Implement a reusable sort/filter list view for skills](#project-1-implement-a-reusable-sortfilter-list-view-for-skills)
124+
- [Project 2: Create toasts for success messages](#project-2-create-toasts-for-success-messages)
125+
- [Project 3: Use case-insensitive names rather than IDs in the URL for a topic](#project-3-use-case-insensitive-names-rather-than-ids-in-the-url-for-a-topic)
126+
- [Project 4: Allow users to suggest new questions for a skill](#project-4-allow-users-to-suggest-new-questions-for-a-skill)
127+
- [Project 5: Allow users to suggest edits to concept cards](#project-5-allow-users-to-suggest-edits-to-concept-cards)
128+
- [Project 6: Allow translators to see the changes made in content by editor](#project-6-allow-translators-to-see-the-changes-made-in-content-by-editor)
129+
- [Project 7: Improve linter checks](#project-7-improve-linter-checks)
130+
- [Project 8: Improve unit tests](#project-8-improve-unit-tests)
131+
- [Project 9: Writing Selenium tests for interactions](#project-9-writing-selenium-tests-for-interactions)
132+
- [Project 10: Expose "upload exploration" functionality in admin page](#project-10-expose-%22upload-exploration%22-functionality-in-admin-page)
133+
- [Project 11: Randomize the pretest questions.](#project-11-randomize-the-pretest-questions)
134+
- [Project 12: Multiple choice answers could be shuffled](#project-12-multiple-choice-answers-could-be-shuffled)
135+
- [Project 13: Find ways to make the audio translation tab interface clearer](#project-13-find-ways-to-make-the-audio-translation-tab-interface-clearer)
136+
- [Project 14: Feedback threads in feedback tab do not reorder by recent updates in real time](#project-14-feedback-threads-in-feedback-tab-do-not-reorder-by-recent-updates-in-real-time)
137+
- [Project 15: Speed Improvements](#project-15-speed-improvements)
138+
- [Project 16: Cross Browser Compatibility Improvement - Translation console for Safari](#project-16-cross-browser-compatibility-improvement---translation-console-for-safari)
139+
- [Project 17: Improving the library page experience on mobile](#project-17-improving-the-library-page-experience-on-mobile)
140+
- [Project 18: Accessibility Improvements - Tabbing Order](#project-18-accessibility-improvements---tabbing-order)
141+
- [Project 19: Accessibility Improvements - Fixing Contrast in Image Region Selectors](#project-19-accessibility-improvements---fixing-contrast-in-image-region-selectors)
120142

121143

122144
Intermediate

Instructions-for-editing-roles-or-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
- value -> empty list.
2424
To add actions corresponding to this role follow instructions [here](#add_action).
2525

26-
1.10 Run backend test corresponding to role changes `bash scripts/run_backend_tests.sh --test_target=core.domain.role_services_test`.
26+
1.10 Run backend test corresponding to role changes `python -m scripts.run_backend_tests --test_target=core.domain.role_services_test`.
2727

2828
1.11 Follow instructions [here](#update_user_role) to attach users to this role.
2929

@@ -47,7 +47,7 @@ To add actions corresponding to this role follow instructions [here](#add_action
4747

4848
2.6 Go to feconf.py and delete the role Id variable corresponding to this role.
4949

50-
2.7 Run backend test corresponding to role changes `bash scripts/run_backend_tests.sh --test_target=core.domain.role_services_test`.
50+
2.7 Run backend test corresponding to role changes `python -m scripts.run_backend_tests --test_target=core.domain.role_services_test`.
5151

5252
***
5353

Performance-Testing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
### Running tests.
22

3-
To run performance tests for all pages:
3+
To run performance tests for all pages:
44
``
5-
bash scripts/run_performance_tests.sh
5+
python -m scripts.run_performance_tests
66
``
77

8-
To run test for a specific page:
8+
To run test for a specific page:
9+
``
10+
python -m scripts.run_performance_tests --test_name=page_test
911
``
10-
bash scripts/run_performance_tests.sh --test_name=page_test
11-
``
1212

1313
page_test is the name of the file containing that test eg. splash_test. Refer to `core/tests/performance_tests` directory for the files containing these tests.
1414

1515
### The Framework.
1616

17-
The framework has two major components to it:
17+
The framework has two major components to it:
1818

19-
1. Performance Data Fetcher:
20-
We use selenium and browsermob-proxy to fetch performance data for the different Oppia pages.
21-
Selenium helps in programmatically interacting with a browser and browsermob-proxy is used to capture HTTP Archive (referred to as HAR) data by recording the communication between the client and server.
19+
1. Performance Data Fetcher:
20+
We use selenium and browsermob-proxy to fetch performance data for the different Oppia pages.
21+
Selenium helps in programmatically interacting with a browser and browsermob-proxy is used to capture HTTP Archive (referred to as HAR) data by recording the communication between the client and server.
2222
The **HTTP Archive** format is a JSON-formatted archive file format used for logging a web browser's interaction with a site. It contains detailed performance data, including information about page loading and displaying and per-resource statistics. Each entry contains the URL requested and request and response headers. For additional details, please see: https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/HAR/Overview.html
2323

24-
2. Performance Metrics Provider:
25-
Refer to: `PageSessionMetrics` and `MultiplePageSessionMetrics` objects in `perf_domain.py`.
24+
2. Performance Metrics Provider:
25+
Refer to: `PageSessionMetrics` and `MultiplePageSessionMetrics` objects in `perf_domain.py`.
2626

2727
### Metrics that we consider.
2828

@@ -62,4 +62,4 @@ To write tests for a new Oppia page:
6262
### Issues
6363

6464
* `WebDriverException: Message: chrome not reachable`:
65-
Try setting bypass proxy for local addresses if you are behind a proxy server.
65+
Try setting bypass proxy for local addresses if you are behind a proxy server.

0 commit comments

Comments
 (0)