Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aconstas committed Mar 13, 2024
1 parent 829c947 commit 70677a2
Showing 1 changed file with 39 additions and 20 deletions.
59 changes: 39 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Internship Design System

This design system is a project of Hack for LA. It helps teams customize and develop their websites and applications. This design system is meant to provide necessary web components and make them easy to custom
This design system is a project of _Hack for LA_. It helps teams customize and develop their websites and applications. This design system is meant to provide necessary web components and make them easy to customize.

### Technology used

Expand All @@ -10,55 +10,74 @@ This design system is a project of Hack for LA. It helps teams customize and dev
- [Material for MK Docs](https://squidfunk.github.io/mkdocs-material/)
- [SASS](https://sass-lang.com/)


# How to contribute

Explain the different ways people can contribute. For example:
<!-- Explain the different ways people can contribute. For example: -->

- This is a project of Hack for LA, please [Join here](https://www.hackforla.org/join)
- Join the team on Slack on [#internship](https://hackforla.slack.com/archives/C01VAUPU788)



## Installation instructions

1. Pull The Repo
1. Fork and Clone this Repository (see **Working with forks and branches** below)
2. Install Dependecies
3. Launch Local Server

3. Launch Local Server `mkdocs serve`

### Working with issues

- Explain how to submit a bug.
<!-- - Explain how to submit a bug.
- Explain how to submit a feature request.
- Explain how to contribute to an existing issue.

To create a new issue, please use the blank issue template (available when you click New Issue). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link.
- Explain how to contribute to an existing issue. -->

To create a new issue, please use the blank issue template (available when you click "New Issue"). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link.

### Working with forks and branches

- Explain your guidelines here.
- **Forks**: Personal copies of other repositories.

To fork this repository, click the "Fork" button at the top of the repository. Then, clone your fork in the desired directory on your machine with:

### Working with pull requests and reviews
`git clone https://github.com/{YOUR-GITHUB-HANDLE}/internship-website-design-system.git`

- Explain your process.
- **Branches**: a separate line of development created to work on new features or fixes independently from the main codebase.

When working in your fork, feature development/fixes should occur in dedicated branches rather than the `main` branch.

### Testing
Once you have a feature/issue that you understand and are ready to work on:

- Provide instructions.
- Ensure your fork remains current by updating it with the latest changes from the original repository.

`git pull upstream main`

- Create a new branch

# Contact info
`git checkout -b new-feat-branch`

- Make changes and review changed files with

`git status`

Include at least one way (or more, if possible) to reach your team with questions or comments.
- Add `git add <file_name>`, Commit `git commit -m "{message}"`, and Push `git push -u origin new-feat-branch` changes when ready.

For more information please refer to ["Git feature branch workflow"](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow#:~:text=The%20core%20idea%20behind%20the,without%20disturbing%20the%20main%20codebase).

### Working with pull requests and reviews

- Branches make **code reviews** possible through **pull requests** (PR).

After pushing your branch to the fork, navigate to the [original repository](https://github.com/hackforla/internship-website-design-system) on GitHub. You'll see an option to **"Compare & pull request"** for the branch you've just updated. Follow the prompts to submit your pull request for review.

### Testing

- Run the site locally with `mkdocs serve`
- Observe visual changes for desktop sized screens as well as mobile.

# Contact info

- Message the team on Slack: [#internship](https://hackforla.slack.com/archives/C01VAUPU788)

### Licensing

Include details about the project's open source status.

*this readme file sourced from [Jessica Sand](http://jessicasand.com/other-stuff/just-enough-docs/)*
_this readme file sourced from [Jessica Sand](http://jessicasand.com/other-stuff/just-enough-docs/)_

0 comments on commit 70677a2

Please sign in to comment.