-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: very good engineering section, credits, contributing (#61)
- Loading branch information
Showing
8 changed files
with
72 additions
and
6 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
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,41 @@ | ||
--- | ||
title: Contributing | ||
description: Very Good Engineering contribution guide. | ||
--- | ||
|
||
## Setup | ||
|
||
We welcome (and encourage) contributions to Very Good Engineering! | ||
|
||
Since this is an [Astro] static website with the [Starlight] theme, you'll need to make sure you've installed [NVM] and the latest stable version of [Node.js]. | ||
|
||
### GitHub PAT | ||
|
||
At build time, we dynamically fetch information about GitHub repositories so our cards on the home page are rendered with up-to-date information about the repositories they are linking to. To avoid being throttled by GitHub on rebuilds, you may wish to [create a GitHub PAT][github-pat] with permission to read public repositories and add it to your environment variable in your `.zshrc` or `.bashrc` file: | ||
|
||
``` | ||
export VGVENTURES_GITHUB_PAT="(your github pat string)" | ||
``` | ||
|
||
## Contributions | ||
|
||
Once you've made changes, you'll want to lint and format your code before submitting a pull request: | ||
|
||
```bash title="Terminal" | ||
npm run lint | ||
npm run format | ||
``` | ||
|
||
:::note | ||
For substantial content changes or additions, we encourage you to first file an [issue] or raise a [discussion] so that we can consider the proposed changes. | ||
|
||
For small grammatical or typographical errors, feel free to submit a pull request directly. | ||
::: | ||
|
||
[Astro]: https://astro.build/ | ||
[Starlight]: https://starlight.astro.build/ | ||
[NVM]: https://github.com/nvm-sh/nvm | ||
[Node.js]: https://nodejs.org/ | ||
[issue]: https://github.com/VGVentures/very_good_engineering/issues | ||
[discussion]: https://github.com/VGVentures/very_good_engineering/discussions | ||
[github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token |
File renamed without changes.
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 @@ | ||
--- | ||
title: Credits | ||
description: Very Good Engineering credits and attributions. | ||
--- | ||
|
||
Made possible by the following open source projects: | ||
|
||
- [Astro] | ||
- [Starlight] | ||
- [NVM] | ||
- [Node.js] | ||
|
||
Our landing page graphic combines several wonderful, free assets: | ||
|
||
- [Smartphone] | ||
- [Laptop] | ||
- [Unicorn] | ||
|
||
[Astro]: https://astro.build/ | ||
[Starlight]: https://starlight.astro.build/ | ||
[NVM]: https://github.com/nvm-sh/nvm | ||
[Node.js]: https://nodejs.org/ | ||
[Smartphone]: https://sketchfab.com/3d-models/smartphone-793ce4333ddb4cb8ab30c6b1da96df81 | ||
[Laptop]: https://sketchfab.com/3d-models/laptop-7d870e900889481395b4a575b9fa8c3e | ||
[Unicorn]: https://sketchfab.com/3d-models/just-a-unicorn-8d0ae2d4b1ac4d1f8ab2adcdcc01cc8f |
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.