Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ER: Add Basic Testing Instructions to CONTRIBUTING.md #6552

Closed
4 of 7 tasks
gaylem opened this issue Mar 30, 2024 · 13 comments
Closed
4 of 7 tasks

ER: Add Basic Testing Instructions to CONTRIBUTING.md #6552

gaylem opened this issue Mar 30, 2024 · 13 comments
Assignees
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level ER Emergent Request Feature: Wiki Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers size: 0.25pt Can be done in 0.5 to 1.5 hours

Comments

@gaylem
Copy link
Member

gaylem commented Mar 30, 2024

Emergent Requirement - Problem

We've noticed that some volunteers aren't testing their issues or PRs thoroughly. This may be because...

  • Testing instructions are somewhat scattered, which makes it hard to know how to test sometimes.
  • New volunteers don't always know that they should test an issue, or how they should test it, before they submit a PR or approve one.

We recommend making some minor updates to the CONTRIBUTING.md file to make sure people are reminded to test and have basic instructions at the ready.

Because we are working on a new wiki, these instructions don't need to be intricate. This is mostly intended to be a stop-gap measure and a reminder.

Issue you discovered this emergent requirement in

N/A

Date discovered

2024/03/29

Did you have to do something temporarily

  • YES
  • NO

Who was involved

@roslynwythe

What happens if this is not addressed

New volunteers (and even more experienced ones) may be deterred from testing due to the challenges associated with it, or they may just forget to do it.

Resources

N/A

Recommended Action Items

  • Make a new issue
  • Discuss with team
  • Let a team lead know

Potential solutions [draft]

  • Create an Issue (medium) using the draft below
  • Customize the draft
### Overview
[write something here]

### Action Items
- [ ] Add a new section 2.8 section to [CONTRIBUTING.md](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)
   - [ ] Write an explanation that detailing the need for testing issues before submitting pull requests
   - [ ] Link to the testing instructions in the [Pull Request wiki](https://github.com/hackforla/website/wiki/How-to-review-Pull-Requests#Step3) for frontend testing.
   - [ ] Link to the following GHA instructions for backend/DevOps testing: 
      - [ ] [HfLA GitHub Actions](https://github.com/hackforla/website/wiki/HfLA-GitHub-Actions)
      - [ ] [Tip 6: Creating your own Project Board](https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions#tip-6-creating-your-own-project-board)
      - [ ] [Tip 7: Using Personal Access Tokens 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) 
    - [ ] 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](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)
@gaylem gaylem added Feature Missing This label means that the issue needs to be linked to a precise feature label. size: 0.25pt Can be done in 0.5 to 1.5 hours ER Emergent Request role missing Complexity: Missing labels Mar 30, 2024

This comment was marked as outdated.

@gaylem gaylem added Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: writing Tasks for writers role: back end/devOps Tasks for back-end developers ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Complexity: Missing Feature Missing This label means that the issue needs to be linked to a precise feature label. role: writing Tasks for writers role missing labels Mar 30, 2024
@roslynwythe

This comment was marked as resolved.

@roslynwythe roslynwythe added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Mar 31, 2024
@gaylem

This comment was marked as resolved.

@ExperimentsInHonesty

This comment was marked as resolved.

@ExperimentsInHonesty ExperimentsInHonesty added ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Ready for Prioritization labels Apr 2, 2024
@gaylem gaylem changed the title ER: Add Testing Instructions to CONTRIBUTING.md ER: Add Basic Testing Instructions to CONTRIBUTING.md and Pull Requests Wiki Apr 5, 2024
@roslynwythe

This comment was marked as resolved.

@gaylem

This comment was marked as resolved.

@gaylem gaylem changed the title ER: Add Basic Testing Instructions to CONTRIBUTING.md and Pull Requests Wiki ER: Add Basic Testing Instructions to CONTRIBUTING.md Apr 7, 2024
@roslynwythe roslynwythe added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels Apr 7, 2024
@ExperimentsInHonesty ExperimentsInHonesty added the Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level label Apr 10, 2024
@ExperimentsInHonesty ExperimentsInHonesty added the Issue Making: Level 2 Make issue(s) from an ER or Epic label Apr 10, 2024
@ExperimentsInHonesty

This comment was marked as resolved.

@gaylem

This comment was marked as resolved.

@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty ExperimentsInHonesty added Complexity: Medium and removed Complexity: Small Take this type of issues after the successful merge of your second good first issue labels Jun 4, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this to ERs and epics that are ready to be turned into issues in P: HfLA Website: Project Board Jun 23, 2024
@santisecco santisecco self-assigned this Nov 22, 2024
@HackforLABot
Copy link
Contributor

Hi @santisecco, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@santisecco
Copy link
Member

i. Availability: Fri-Sun
ii. ETA: 11-24-24

@santisecco
Copy link
Member

Created issue #7762 to address this ER

@daras-cu daras-cu moved this from ERs and epics that are ready to be turned into issues to In progress (actively working) in P: HfLA Website: Project Board Jan 22, 2025
@t-will-gillis
Copy link
Member

Hey @santisecco

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level ER Emergent Request Feature: Wiki Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers size: 0.25pt Can be done in 0.5 to 1.5 hours
Projects
Development

No branches or pull requests

6 participants