website
website copied to clipboard
Update CONTRIBUTING.md Section 2.7.d and 2.7.e
Prerequisite
- 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.
- 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
In Section 2.7.d we instruct devs to sync their fork with origin and to pull upstream changes from gh-pages into their topic branch. However, many of the remaining instructions in 2.7.d and 2.7.e are redundant in most cases.
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