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

Create Issue Template for Updates to CONTRIBUTING.md #5547

Closed
3 tasks done
roslynwythe opened this issue Sep 17, 2023 · 3 comments · Fixed by #5570
Closed
3 tasks done

Create Issue Template for Updates to CONTRIBUTING.md #5547

roslynwythe opened this issue Sep 17, 2023 · 3 comments · Fixed by #5570
Assignees
Labels
Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Sep 17, 2023

Prerequisite

  1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page and attend an onboarding session.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA Guide.

Overview

We need to create a GitHub issue template for updates to CONTRIBUTING.md so that issues can be created efficiently and so that we can provide developers with special instructions for previewing changes to CONTRIBUTING.md.

Action Items

  • Create a new file .github/ISSUE_TEMPLATE/update-CONTRIBUTING.md with YAML frontmatter:
---
name: update CONTRIBUTING.md
about: 'For making updates to CONTRIBUTING.md'
title: 'Update CONTRIBUTING.md Section [INSERT SECTION #]'
labels: 'Feature: Wiki, Complexity: Small, role: back
  end/devOps, role: front end, size: 0.5pt'
assignees: ''

---
  • The body of the issues should come from this template
  • Refer to these instructions for testing and preparing the Pull Request.

Resources/Instructions

Manually creating a single issue template for your repository

@roslynwythe roslynwythe added role: back end/devOps Tasks for back-end developers Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly size: 1 pt labels Sep 17, 2023
@wanyuguan wanyuguan added size: 1pt Can be done in 4-6 hours and removed size: 1 pt labels Sep 17, 2023
@roslynwythe
Copy link
Member Author

roslynwythe commented Sep 17, 2023

Prerequisite

  1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page and attend an onboarding session.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA Guide.

Overview

[INSERT BRIEF DESCRIPTION OF THE UPDATE]

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • Replace
[INSERT LINE OF CURRENT CODE HERE]

with

[INSERT DESIRED LINE OF CODE HERE]
  • With CONTRIBUTING.md still open, make a note of the section in which the replaced content appears, so that you will know where to look in the document to preview the change.
  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must 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/Instructions

CONTRIBUTING.md
Getting started with writing and formatting on GitHub

@wanyuguan wanyuguan added this to the 08. Team workflow milestone Sep 17, 2023
@erinzz erinzz self-assigned this Sep 18, 2023
@github-actions
Copy link

Hi @erinzz, 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 :)

@erinzz
Copy link
Member

erinzz commented Sep 18, 2023

Availability: M-F 9-5
ETA: 9/21 EOD

roslynwythe pushed a commit that referenced this issue Sep 28, 2023
* created issue template for updating to CONTRIBUTING.md #5547

* Capitalized 'U' in name field for issue template consistency

* updated corrected front matter and body of template

* 2nd correction and update for front matter and template body
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly role: back end/devOps Tasks for back-end developers size: 1pt Can be done in 4-6 hours
Projects
Development

Successfully merging a pull request may close this issue.

4 participants