You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adding test instructions and links to CONTRIBUTING.md #7762 (#8195)
* added links and new testing instructions in section 2.7
* added spaces at the end of links for formating
* added breaks instead of spaces
* added one more break
* fixed typos and syntax requested in PR
* ln 528 & 564 syntax edit
* backtick moved
* backtick moved
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,8 +51,9 @@ The following is a set of guidelines for contributing to the website repository,
51
51
-[**2.6.b What to do if you have to stop working mid issue:**](#26b-what-to-do-if-you-have-to-stop-working-mid-issue)
52
52
-[**2.7 Working on an issue**](#27-working-on-an-issue)
53
53
-[**2.7.a Working on an issue (1): Verify current branch is `gh-pages`**](#27a-working-on-an-issue-1-verify-current-branch-is-gh-pages)
54
-
-[**2.7.b Working on an issue (2): Creating and testing your issue branch**](#27b-working-on-an-issue-2-creating-and-testing-your-issue-branch)
55
-
-[**i. A few notes regarding Docker:**](#i-a-few-notes-regarding-docker)
54
+
-[**2.7.b Working on an issue (2): Creating your issue branch and testing your code changes**](#27b-working-on-an-issue-2-creating-your-issue-branch-and-testing-your-code-changes)
55
+
-[**i. Creating your issue branch**](#i-creating-your-issue-branch)
56
+
-[**ii. Testing your code changes**](#ii-testing-your-code-changes)
56
57
-[**2.7.c Working on an issue(3): Prepare your changes to push to your repository**](#27c-working-on-an-issue3-prepare-your-changes-to-push-to-your-repository)
57
58
-[**i. Prepare repo changes (1): Use the `git add` command to stage your changes.**](#i-prepare-repo-changes-1-use-the-git-add-command-to-stage-your-changes)
58
59
-[**ii. Prepare repos changes (2): Use the `git status` command to see what files are staged.**](#ii-prepare-repos-changes-2-use-the-git-status-command-to-see-what-files-are-staged)
@@ -522,7 +523,9 @@ git pull upstream gh-pages
522
523
523
524
<sub>[Back to Table of Contents](#table-of-contents)</sub>
524
525
525
-
#### **2.7.b Working on an issue (2): Creating and testing your issue branch**
526
+
#### **2.7.b Working on an issue (2): Creating your issue branch and testing your code changes**
527
+
528
+
##### **i. Creating your issue branch**
526
529
527
530
If you have not already done so, run `git checkout gh-pages` to switch the working directory to the `gh-pages` branch and then update `gh-pages` with upstream changes as described above in Section 2.7.a.
528
531
@@ -548,7 +551,19 @@ We urge developers to be cautious using `git add`. In general it is not advisabl
548
551
549
552
When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.
550
553
551
-
##### **i. A few notes regarding Docker:**
554
+
##### **ii. Testing your code changes**
555
+
556
+
1. Importance of testing
557
+
558
+
- Testing is a fundamental step to ensure quality of code and that code changes are functioning as expected. We don't want to debug or find solutions for features while the code is already in a production environment in real time. For some it's not the most engaging step and skip it, others simply have not done it before, and some may see it as unecessary time consuming step. The reasoning behind testing is that we'll be able to quickly identify bugs more easily and save time in the future instead of creating future time debt to debug. Fixing easily preventable bugs is the idea and testing gives us a tool to come up with new solutions and improve our code. [Testing a pull request for frontend](https://github.com/hackforla/website/wiki/How-to-review-Pull-Requests#Step3)
559
+
- Here are some additional links for backend/DevOps testing:<br>
[Creating your own project board](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions#tip-6-creating-your-own-project-board)<br>
562
+
[Using your own personal access token to test in your own project board](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions#tip-7-using-personal-access-tokens-to-test-in-your-own-project-board)
563
+
564
+
- Make sure to comment on your issue if you aren't sure how to test something, and then to put it in the **Questions / In Review column** and add the `ready for dev lead` label. Paste a link to your comments in the #hfla-site Slack channel asking peers for help.
565
+
566
+
2. A few notes regarding Docker:
552
567
553
568
- To test your issue branch locally, run the command "docker-compose up" from a terminal window. The website will then be accessible at http://localhost:4000.
0 commit comments