@@ -9,11 +9,23 @@ redirect_from:
99---
1010
1111
12+ Join our Community Discussion on Zulip:
13+ [ Contact Us] ( /contact )
1214
13- ## Suggestions for New Developers
15+ ## Setting Up
1416
15- * Join our Community Discussion on Zulip:
16- [ Contact Us] ( /contact )
17+ * Submitty primarily uses the following languages/frameworks:
18+ [ PHP] ( /developer/software_and_system_design/coding_style_guide/php ) ,
19+ [ Twig] ( /developer/developing_the_php_site/view#rendering-the-user-page-with-twig ) ,
20+ [ JavaScript] ( /developer/software_and_system_design/coding_style_guide/javascript ) ,
21+ [ TypeScript] ( /developer/developing_the_php_site/javascript#typescript ) ,
22+ [ Vue] ( /developer/developing_the_php_site/view#another-option-rendering-with-vue ) ,
23+ [ PostgreSQL] ( /developer/software_and_system_design/database_design ) ,
24+ [ Python] ( /developer/software_and_system_design/coding_style_guide/python ) ,
25+ [ C++] ( /developer/software_and_system_design/coding_style_guide/c++ ) .
26+
27+ * To support development, Submitty uses Git/GitHub, Vagrant, [ Cypress E2E Testing] ( /developer/testing/cypress ) ,
28+ PHP/Python unit tests, and a variety of linters and formatters.
1729
1830* You'll need to set up the full system on your own computer. The
1931 easiest method is to
@@ -23,13 +35,13 @@ redirect_from:
2335 up networking, SSL/https, etc.) by following the
2436 [ complete system administrator instructions] ( /sysadmin/installation/index ) .
2537
26- * Read through the
38+ * Once the system has been successfully installed, read through the
2739 [ Student] ( /student/account/index ) ,
2840 [ Grader] ( /grader/index ) , and
2941 [ Instructor] ( /instructor )
30- instructions and try it out.
42+ instructions to test it out.
3143
32- * Learn how to use git.
44+ ## Making Contributions
3345
3446* Browse our open [ GitHub Pull Requests] ( https://github.com/Submitty/Submitty/pulls ) .
3547 Pick an open PR and read the PR notes, linked issues, and other documentation.
@@ -39,42 +51,38 @@ redirect_from:
3951
4052* Look through our [ GitHub Issues lists] ( https://github.com/Submitty/Submitty/issues ) for some ideas
4153 of problems to explore.
42-
4354 * _ ** IMPORTANT NOTE** : We can only "assign" GitHub issues to users
44- who are already members of the Submitty GitHub organization. But
55+ who are already members of the Submitty GitHub organization, however,
4556 we are very happy to accept, review, and merge contributions from
46- outside of the organization. Students selected for Google Summer
57+ outside of the organization. Students selected for Google Summer
4758 of Code and active developers who already have multiple
4859 contributions will be added to the Submitty GitHub organization._
49-
60+
5061* Learn what sections of the code are relevant for those issues (so
5162 you’re not overwhelmed).
52-
53- * Hint: Use "git grep" to search for variables/filenames/specific
63+ * Use "git grep" to search for variables/filenames/specific
5464 strings within the source files/directories. This can help you
5565 locate relevant files.
66+ * For Developers using VS Code: Use ` Ctrl+Shift+F ` to search for words inside
67+ of files. Use ` Ctrl+P ` to search for filenames.
5668
5769* Add & delete things to the code, re-install that portion of the
5870 system and see what happens. See also [ Development Instructions] ( /developer/development_instructions ) .
5971
60- * Use inspector, browser debugger, javascript console, etc.
61-
62- * Hint: It is helpful to set your javascript console errors to
63- be persistent (so they don't disappear when the page reloads).
64- E.g., in Chrome, you need to set "Console: Preserve log on
65- navigation", or in Firefox, "Enable persistent logs".
66-
67- * As you read the code, make a diagram for yourself of how the system
68- fits together.
69-
70- * Use jsfiddle (for testing or demoing new things).
72+ * Browser DevTools allow you to inspect, debug, and experiment with web pages.
73+ * The ` Elements/Inspector ` tab provides a view of the DOM, and the CSS classes being applied to elements.
74+ * The ` Console ` tab shows browser messages and allows you to run JS on the page.
75+ * Use ` console.log ` in JavaScript to output to the console.
76+ * HINT: Set your javascript console errors to
77+ be persistent. This will make any outputs persist on reload.
78+ * The ` Network ` tab is helpful for seeing what requests are being made.
79+ * The ` Application/Storage ` tab allows you to view cookies and items in localStorage.
7180
72- * Keep a work diary / log: what did you plan to do today, keep track
73- of how long it took you to do things, difficulties, how did you
74- solve it, helpful reference links, and what’s your plan for
75- tomorrow.
81+ ## Helpful Links
7682
77- * Get familiar with vagrant.
83+ These links may be useful throughout your development experience. _ REMEMBER:_ If
84+ you ever have any questions about the Submitty's workflow, the codebase, or a
85+ specific feature, search ` submitty.org ` first.
7886
7987* Run the relevant portions of test suite locally:
8088 [ Submitty Testing Instructions] ( /developer/testing/ )
0 commit comments