Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chandlerroth authored May 6, 2024
1 parent bec306c commit ad25636
Showing 1 changed file with 4 additions and 35 deletions.
39 changes: 4 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
<a href="https://www.figma.com/file/j5Qp1h40CyerLugwq44yo3/EngineerKit-Map?node-id=585-21&t=GlzxDBEN0EJss6j7-0">
<img width="1440" alt="EngineerKit Map" src="https://user-images.githubusercontent.com/894178/179018751-20047cf8-769d-4f80-ae9e-822be193bd87.png">
</a>

<hr />

EngineerKit is a collection of knowledge, tools, and skills that we've come to find useful to become a generalist software engineer.
A collection of knowledge, tools, and skills that we've come to find useful to become a generalist software engineer.

<p>
<a aria-label="SDK version" href="https://github.com/engineerkit/engineerkit/tags" target="_blank">
<img alt="EngineerKit version" src="https://img.shields.io/github/v/tag/engineerkit/engineerkit.svg?style=flat-square&label=Version&labelColor=000000&color=2068F3" />
<img alt="version" src="https://img.shields.io/github/v/tag/engineerkit/engineerkit.svg?style=flat-square&label=Version&labelColor=000000&color=2068F3" />
</a>
<a aria-label="Join our Discord" href="https://discord.gg/bDVYvG3Czd" target="_blank">
<img alt="Discord" src="https://img.shields.io/discord/903472181248421969.svg?style=flat-square&labelColor=000000&color=2068F3&logo=discord&logoColor=FFFFFF&label=" />
Expand All @@ -20,7 +14,7 @@ EngineerKit is a collection of knowledge, tools, and skills that we've come to f

## Overview

- [Getting started with EngineerKit](overview/README.md)
- [Getting started](overview/README.md)

## Modules

Expand Down Expand Up @@ -48,30 +42,5 @@ These [15 modules](modules/) represent a generalist software engineer's core kno

## Contributing

A great way to start contributing is to first [join our Discord](https://discord.gg/bDVYvG3Czd) to connect with the EngineerKit community!

<details>
<summary><b>Pulling upstream changes from <a href="https://github.com/engineerkit/engineerkit">engineerkit/engineerkit</a> into your private fork</b></summary><br/>

While we always promote sharing with the open-source community, some companies might find it necessary to privately fork EngineerKit if they have some software engineering standards they want to keep to themselves. Here's a quick guide on how to do this with EngineerKit:
A great way to start contributing is to first [join our Discord](https://discord.gg/bDVYvG3Czd) to connect with the Enok community!

- First clone down your private repo
- To add a new remote to your local repo connected to the `engineerkit/engineerkit` repo, run
```
git remote add public [email protected]:engineerkit/engineerkit.git
```
- To create a branch where you'll pull changes into, run
```
git checkout -b add_awesome_new_topics
```
- To pull down changes into your new branch, run
```
git pull public main
```
- Resolve any merge conflicts
- To push up your changes to your private fork, run
```
git push
```
</details>

0 comments on commit ad25636

Please sign in to comment.