generated from hackforla/.github-hackforla-base-repo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Decision Record directory structure and file names (#8)
* Created new folder structure for decision records * Rename files in DR directory * Remove duplicate folder Decision-Records
- Loading branch information
Showing
24 changed files
with
341 additions
and
195 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
nav: | ||
- Decision Records: index.md | ||
- ✅ Solutions Adopted: adopted | ||
- ⛔ Not Implemented: not_implemented | ||
- Decisions Records Management: decision-records-management.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
status: ✅ Adopted | ||
--- | ||
|
||
#### Issue | ||
|
||
[#2651](https://github.com/hackforla/website/issues/2651) | ||
|
||
#### Problem Statement | ||
|
||
Identifying a linter which can be installed locally so that developers can identify errors before making a PR. | ||
|
||
#### Potential Solution | ||
|
||
Having developers set up [ESLint](https://eslint.org/) on their local machines. | ||
|
||
#### Feasibility Determination | ||
|
||
In order to implement ESLint for standard use, all developers on the team (old and new) would have to individually install it on their local machines, which could be a bit to handle. | ||
|
||
#### Summary | ||
|
||
- Potential linters for use on developers' local machines were researched as requested by issue #2651 and ESLint was suggested as a possible solution, however a decision cannot be made until a spell checker for the repo is decided on so that we can determine compatability. | ||
- If the decision to implement ESLint as the standard local linter were made, we would need to add the files it creates to the main repo; a package.json and .eslintrc.yml config file and we would also have to implement ESLint onto the repo with Github actions so that the repo linter matches everyone's local linter. | ||
- A roll out plan would also need to be developed to ensure that everyone who is actively working and newly working on the website repo knows they need to implement ESLint on their local environments. |
28 changes: 16 additions & 12 deletions
28
...LASP-in-Google-Apps-Script-Development.md → ...gle-apps-script-development-with-clasp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,23 @@ | ||
This is a record in the [Decision Records on Solutions Adopted](Decision-Records-on-Solutions-Adopted). | ||
--- | ||
status: ✅ Adopted | ||
--- | ||
|
||
### Issue | ||
- [CLASP for Google Apps Scripts development evaluation / decision #3722](https://github.com/hackforla/website/issues/3722) | ||
#### Issue | ||
|
||
### Problem Statement | ||
- The decision had been made to bring Google Apps Scripts into the website GitHub repository, resulting in issue [Add latest version of Google Apps Scripts to GitHub #3641](https://github.com/hackforla/website/issues/3641). In the context of that issue, the suggestion to use clasp was made. | ||
[#3722](https://github.com/hackforla/website/issues/3722) | ||
|
||
#### Problem Statement | ||
|
||
- The decision had been made to bring Google Apps Scripts into the website GitHub repository, resulting in issue [Add latest version of Google Apps Scripts to GitHub #3641](https://github.com/hackforla/website/issues/3641). In the context of that issue, the suggestion to use clasp was made. | ||
- The Apps Script CLI, or clasp, is an npm module with commands to create, edit, and deploy Apps Script projects locally. For Hack for LA, its most useful commands would be clone, pull and push for transferring code modules between Google Drive and the local workstation, to facilitate local editing and committing of code. The tool would provide an alternative to copying/pasting code between Google Drive and the local workstation, which may be feasible for work on our current small codebase, but will become unwieldy if the codebase grows. | ||
|
||
### Feasibility Determination | ||
- Use of clasp is feasible and will provide benefits especially for devs who prefer to edit code in their local IDE, and especially if the codebase were to grow. | ||
- Use of clasp will create a larger learning curve and setup time for new devs, including installation of node.js, npm, clasp, @types/google-apps-script, clasp-env. | ||
- It would be possible to combine clasp with other npm modules such as prettifier, ESLint, Babel and tsgas, to create a custom "build/deploy" module. | ||
#### Feasibility Determination | ||
|
||
### Summary | ||
- Create a new issue [#4134](https://github.com/hackforla/website/issues/4134) to document the new Google Apps Script development process. | ||
- Update existing wins development issues to refer to new wiki page. | ||
- Use of clasp is feasible and will provide benefits especially for devs who prefer to edit code in their local IDE, and especially if the codebase were to grow. | ||
- Use of clasp will create a larger learning curve and setup time for new devs, including installation of node.js, npm, clasp, @types/google-apps-script, clasp-env. | ||
- It would be possible to combine clasp with other npm modules such as prettifier, ESLint, Babel and tsgas, to create a custom "build/deploy" module. | ||
|
||
#### Summary | ||
|
||
- Create a new issue [#4134](https://github.com/hackforla/website/issues/4134) to document the new Google Apps Script development process. | ||
- Update existing wins development issues to refer to new wiki page. |
10 changes: 8 additions & 2 deletions
10
...n-issue-that-needs-follow-up-by-a-lead.md → ...opted/hand-off-issue-follow-up-by-lead.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
This is a record in the [Decision Records on Solutions Adopted](Decision-Records-on-Solutions-Adopted). | ||
--- | ||
status: ✅ Adopted | ||
--- | ||
|
||
#### Issue | ||
|
||
None | ||
|
||
#### Problem Statement | ||
|
||
How to pass off an issue that needs follow-up by a lead? Also, how to keep track of those issues that need follow-up? | ||
|
||
#### Potential Solution | ||
|
||
- Add a `ready for [INSERT ROLE] lead` label to the issue, such as `ready for dev lead` or `ready for design lead` | ||
- Then, the respective leads will check the `ready for [INSERT ROLE] lead` for their role and follow up with the issue. | ||
|
||
#### Feasibility Determination | ||
This is feasible. Also, it allows a way to pass off an issue that needs follow-up by a lead and it keeps track of issues that still need follow-up by just filtering by the label. | ||
|
||
This is feasible. Also, it allows a way to pass off an issue that needs follow-up by a lead and it keeps track of issues that still need follow-up by just filtering by the label. |
25 changes: 14 additions & 11 deletions
25
...ecords/DR-Toolkit's-page-hidden-button.md → ...DR/adopted/hide-button-on-toolkit-page.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,34 @@ | ||
This is a record in the [Decision Records on Solutions Adopted](Decision-Records-on-Solutions-Adopted). | ||
--- | ||
status: ✅ Adopted | ||
--- | ||
|
||
#### Issue | ||
|
||
**Issue** | ||
* #3678 | ||
* https://github.com/hackforla/website/issues/3678 | ||
[#3678](https://github.com/hackforla/website/issues/3678) | ||
|
||
**Problem Statement** | ||
#### Problem Statement | ||
|
||
Checking to see if the Suggest a guide button has been succesffully hidden. | ||
Checking to see if the Suggest a guide button has been successfully hidden. | ||
|
||
**Potential Solution** | ||
#### Potential Solution | ||
|
||
Using Dockers to check to see if the button has been hidden and the button is still within toolkit.html | ||
|
||
**Feasibility Determination** | ||
#### Feasibility Determination | ||
|
||
The potential Solution is feasible as the button has been hidden. After reviewing the initial site on the local machine, the button is not displayed. | ||
The potential Solution is feasible as the button has been hidden. After reviewing the initial site on the local machine, the button is not displayed. | ||
![image](https://user-images.githubusercontent.com/38971729/220494923-cb61f083-7648-4dac-995f-9e575a5e68a1.png) | ||
|
||
[/pages/toolkit.html](https://github.com/hackforla/website/blob/262395c6b76fa0cc2ecc3a6c4d313e96dd1d2346/pages/toolkit.html#L62): | ||
``` | ||
|
||
```html | ||
62 <div class="suggest-guide-group"> | ||
63 <h2 class="external-resources-text title3">External Resources</h2> | ||
64 <!-- The Suggest a resource button has been temporarily hidden until we figure out how this button will function after it's clicked. See issue #3678 for more details. --> | ||
65 <button hidden class="btn btn-primary btn-md-narrow">Suggest a resource</button> | ||
66 </div> | ||
``` | ||
|
||
**Summary:** | ||
|
||
As of Febuary 21st, 2023, the button has been successfully hidden and is not displayed currently. | ||
As of Febuary 21st, 2023, the button has been successfully hidden and is not displayed currently. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
status: ✅ Adopted | ||
--- | ||
|
||
#### Issue | ||
|
||
None | ||
|
||
#### Problem Statement | ||
|
||
In our codebase, we are not consistent with whether we apply an ending slash for img HTML tags. | ||
|
||
Example of code with `<img...>`: | ||
<https://github.com/hackforla/website/blob/706d7ce3628f9958cda525201c7c444d3d57d21b/pages/404.html#L12> | ||
|
||
Example of code with `<img.../>` | ||
<https://github.com/hackforla/website/blob/706d7ce3628f9958cda525201c7c444d3d57d21b/pages/donate.html#L18> | ||
|
||
#### Potential Solution | ||
|
||
Use the img HTML tag without an ending slash meaning <img...> (Source 1). | ||
|
||
#### Feasibility Determination | ||
|
||
This is feasible because we only use HTML. An ending slash in an img tag is needed for XHTML and XML (Source 2), which we don't use. | ||
|
||
#### Sources | ||
|
||
1. <https://html.spec.whatwg.org/multipage/embedded-content.html#the-img-element> | ||
2. <https://stackoverflow.com/a/15149657> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 13 additions & 5 deletions
18
...pdating-a-feature-branch-with-gh-pages.md → .../use-merge-commit-for-gh-pages-updates.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.