Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ The following is a set of guidelines for contributing to the website repository,
- [**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)
- [**2.7 Working on an issue**](#27-working-on-an-issue)
- [**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)
- [**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)
- [**i. A few notes regarding Docker:**](#i-a-few-notes-regarding-docker)
- [**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)
- [**i. Creating your issue branch**](#i-creating-your-issue-branch)
- [**ii. Testing your code changes**](#ii-testing-your-code-changes)
- [**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)
- [**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)
- [**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)
Expand Down Expand Up @@ -522,7 +523,9 @@ git pull upstream gh-pages

<sub>[Back to Table of Contents](#table-of-contents)</sub>

#### **2.7.b Working on an issue (2): Creating and testing your issue branch**
#### **2.7.b Working on an issue (2): Creating your issue branch and testing your code changes**

#### **i. Creating your issue branch

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.

Expand All @@ -548,7 +551,19 @@ We urge developers to be cautious using `git add`. In general it is not advisabl

When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.

##### **i. A few notes regarding Docker:**
##### **ii. Testing your code edits**

1. Importance of testing

- Testing is a fundamental step to ensure quality of code and that code changes are functioning as expected. We don't want 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)
- Here are some additional links for backend/DevOps testing:
[HfLA github actions](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions)
[Creating your own project board](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions#tip-6-creating-your-own-project-board)
[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)

- 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.

2. A few notes regarding Docker:

- 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.

Expand Down
Loading