Add Basic Testing Instructions to CONTRIBUTING.md

[santisecco]

Overview

We need to add a new testing section to CONTRIBUTING.md to remind developers to test their code changes. This should be a a minor update to the existing file.

Details

Testing is a fundamental step to ensure quality of code and that code changes are functioning as expected. For some it's not the most engaging step and skip it, others simply forget about it altogether. This is the reason why being reminded to do it and understanding that the time invested doing it saves tons of work down the road is fundamental. Fixing easily preventable bugs is the idea and testing gives us a tool to come up with new solutions and improve our code, making us better developers in the end.

Action Items

• [ ] Open the file CONTRIBUTING.md in your local code editor.
• [ ] In VS Code click the button on the top right corner to open the file preview on the right of your edited file.
  Click here to see the the above.

  
  • [ ] Please look at the preview as you work along.
  • [ ] Add a new section 2.8 section to CONTRIBUTING.md:
  • [ ] To start add the following under section 2.7: - [**2.8 Testing your code**](#28-testing-your-code). Please keep the indentation and proper structure of CONTRIBUTING.md
  • [ ] Write an explanation detailing the need for testing issues. Something similar to the Overview above can be used.
  • [ ] Add the following links to the section, specify what each of them corresponds to either frontend and backend/DevOps:
    • [ ] Link to the testing instructions in the Pull Request wiki for frontend testing.
    • [ ] Link to the following GHA instructions for backend/DevOps testing:
      • [ ] HfLA GitHub Actions
      • [ ] Tip 6: Creating your own Project Board
      • [ ] Tip 7: Using Personal Access Tokens to test in your own Project Board
  • [ ] Write a reminder for volunteers to add comments to their issue if they aren't sure how to test something, and then to put it in the questions column and add the ready for dev lead label. They can also paste a link to their comment in the #hfla-site Slack channel to ask their peers for help.
  • [ ] Changes to CONTRIBUTING.md should not be tested locally, rather they need to be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL. Also store the test URL for use in a later step:

    https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

    (for example: https\://github.com/bonniewolfe/website/blob/issue-branch-1234/CONTRIBUTING.md)

  • [ ] Create a pull request with your changes. In the Pull Request, after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.

    For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]

    Resources

  • CONTRIBUTING.md

[github-actions[bot]]

Hi @santisecco.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

• Complexity, Role, Feature, Size

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels