Skip to content

Commit

Permalink
created issue template for updating to CONTRIBUTING.md hackforla#5547
Browse files Browse the repository at this point in the history
  • Loading branch information
erinzz committed Sep 22, 2023
1 parent c8c3c00 commit 5dccef6
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/update-CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: update CONTRIBUTING.md
about: 'For making updates to CONTRIBUTING.md'
title: 'Update [DESCRIBE CHANGE] in CONTRIBUTING.md'
labels: 'Feature: Wiki, Complexity: Small, ready for dev lead, role: back end/devOps, role: front end, size: 0.5pt'
assignees: ''

---

### 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](https://www.hackforla.org/getting-started) 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](https://github.com/hackforla/website/blob/7f0c132c96f71230b8935759e1f8711ccb340c0f/CONTRIBUTING.md).

### 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 test changes locally, rather test changes at [REPLACE WITH TEST URL]
```

### Resources/Instructions
[CONTRIBUTING.md](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)
[Getting started with writing and formatting on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)

0 comments on commit 5dccef6

Please sign in to comment.