|
1 |
| -# Common issues with pull requests |
2 |
| -1. Hardcoding values |
3 |
| - * If you are hardcoding the same value over and over make a constant for it in Constants.ts and use that new constant instead |
4 |
| - |
5 |
| -2. Non-descript variable names |
6 |
| - * Make sure your variables names are descriptive |
7 |
| - |
8 |
| -3. Passing checks |
9 |
| - * Before submitting a PR make sure you run the tests (`yarn test`) to make sure everything is still working correctly after your changes |
10 |
| - |
11 |
| -4. Imports |
12 |
| - * Before Submitting a PR consult the import style guide to make sure your order of imports adheres to it |
13 |
| - |
14 |
| -5. Please make sure the changes in your PR actually belong in your PR |
15 |
| - * Don't make random or unnecessary changes that don't have anything to do with the issues your working on |
16 |
| - * If you’re working on multiple issues you should have a separate branch and pull request for each issue |
17 |
| - |
18 |
| -6. Run OpenCircuits |
19 |
| - * Make sure OpenCircuits still runs after the changes you've made and test out the changes you've made to ensure they are working |
20 |
| - |
21 |
| -7. Don't re-implement code |
22 |
| - * If you are unsure if some functionality already exists in the codebase you should ask rather attempting to re-implement it |
23 |
| - |
24 |
| -8. Comments |
25 |
| - * If you think a peice of code will be hard for another person to understand make sure to write comments |
26 |
| - |
27 |
| -9. Stick to the code formatting around you |
28 |
| - * make sure the style and formatting of the code is the same before and after you've changed it |
29 |
| - |
30 |
| -10. Tabs |
31 |
| - * Don't submit a PR with tabs in it (any tabs should instead be 4 spaces) |
32 |
| - |
33 |
| -11. Remove extraneous comments |
34 |
| - * If your PR has comments that are no longer relevant to the code make sure to remove them |
35 |
| - |
36 |
| -12. Whitespace |
37 |
| - * Make sure there is no extra whitespace in your PR |
38 |
| - |
39 |
| -13. Make sure you include a space after if |
40 |
| - * Do ```if (bool)``` not ```if(bool)``` |
41 |
| - |
42 |
| -14. Make sure you have an space after each comment |
43 |
| - * Do ```// "stuff"``` not ```//"stuff"``` |
44 |
| - |
45 |
| -15. You do not need to merge master unless there is a conflict |
46 |
| - * You do not need to press the `Update Branch` button (on Github) unless there is a merge conflict |
| 1 | +# Common issues with pull requests |
| 2 | +1. Hardcoding values |
| 3 | + * If you are hardcoding the same value over and over make a constant for it in Constants.ts and use that new constant instead |
| 4 | + |
| 5 | +2. Non-descript variable names |
| 6 | + * Make sure your variables names are descriptive |
| 7 | + |
| 8 | +3. Passing checks |
| 9 | + * Before submitting a PR make sure you run the tests (`yarn test`) to make sure everything is still working correctly after your changes |
| 10 | + |
| 11 | +4. Imports |
| 12 | + * Before Submitting a PR consult the import style guide to make sure your order of imports adheres to it |
| 13 | + |
| 14 | +5. Please make sure the changes in your PR actually belong in your PR |
| 15 | + * Don't make random or unnecessary changes that don't have anything to do with the issues your working on |
| 16 | + * If you’re working on multiple issues you should have a separate branch and pull request for each issue |
| 17 | + |
| 18 | +6. Run OpenCircuits |
| 19 | + * Make sure OpenCircuits still runs after the changes you've made and test out the changes you've made to ensure they are working |
| 20 | + |
| 21 | +7. Don't re-implement code |
| 22 | + * If you are unsure if some functionality already exists in the codebase you should ask rather attempting to re-implement it |
| 23 | + |
| 24 | +8. Comments |
| 25 | + * If you think a peice of code will be hard for another person to understand make sure to write comments |
| 26 | + |
| 27 | +9. Stick to the code formatting around you |
| 28 | + * make sure the style and formatting of the code is the same before and after you've changed it |
| 29 | + |
| 30 | +10. Tabs |
| 31 | + * Don't submit a PR with tabs in it (any tabs should instead be 4 spaces) |
| 32 | + |
| 33 | +11. Remove extraneous comments |
| 34 | + * If your PR has comments that are no longer relevant to the code make sure to remove them |
| 35 | + |
| 36 | +12. Whitespace |
| 37 | + * Make sure there is no extra whitespace in your PR |
| 38 | + |
| 39 | +13. Make sure you include a space after if |
| 40 | + * Do ```if (bool)``` not ```if(bool)``` |
| 41 | + |
| 42 | +14. Make sure you have an space after each comment |
| 43 | + * Do ```// "stuff"``` not ```//"stuff"``` |
| 44 | + |
| 45 | +15. You do not need to merge master unless there is a conflict |
| 46 | + * You do not need to press the `Update Branch` button (on Github) unless there is a merge conflict |
0 commit comments