Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for forking and cloning the repositories #43

Merged
merged 1 commit into from
Oct 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions DOCSREPO.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
# Docs Repository Documentation
[![Waffle.io - Columns and their card count](https://badge.waffle.io/indiehd/docs.svg?columns=all)](https://waffle.io/indiehd/docs)

## Fork The Repository
## Qualifications
* Articulate content writer
* Patience

You would fork [docs](https://github.com/indiehd/docs) if you wanted to submit changes to the documentation
you are currently reading.
## Fork
You would fork [docs](https://github.com/indiehd/docs) if you wanted to submit changes to the documentation you are
currently reading.

It uses the [Docsify](https://docsify.js.org/#/?id=docsify) library for generating the content.

Just click the `Fork` button in the top right of the repository page:

![](../images/fork_button.jpg)

**Contributor Qualifications:**
* Articulate content writer
* Patience

`Documentation under construction`
Once forked, you will then `clone` ***YOUR*** repository to your local machine.

## Clone via HTTPS

?> Replace `<YOU>` with your username or organization!

```
git clone https://github.com/<YOU>/docs.git
```

## Clone via SSH

*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be
added to your github account*

?> Replace `<YOU>` with your username or organization!

```
git clone git@github.com:<YOU>/docs.git
```

## Help
If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)

42 changes: 34 additions & 8 deletions web-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@
[![Waffle.io - Columns and their card count](https://badge.waffle.io/indiehd/docs.svg?columns=all)](https://waffle.io/indiehd/web-api)
[![Build Status](https://travis-ci.org/indiehd/web-api.svg?branch=master)](https://travis-ci.org/indiehd/web-api)

You would fork [web-api](https://github.com/indiehd/web-api) if you want to contribute to the server side Api.

Just click the `Fork` button in the top right of the repository page:

![](../images/fork_button.jpg)

**Repository Responsibilities**
## Repository Duties

* Server side processing
* Database operations
Expand All @@ -18,9 +12,41 @@ Just click the `Fork` button in the top right of the repository page:
* Mail (with mail templates)
* Multi-lang support

**Qualifications**
## Qualifications

* PHP (Specifically [PSR2](https://www.php-fig.org/psr/psr-2/))
* [Laravel Framework](https://laravel.com/docs/5.7)
* Strong understanding of [S.O.L.I.D Principles](https://medium.com/prod-io/solid-principles-takeaways-ec0825a07247)
* Familiarity with [PhpUnit Testing](https://laravel.com/docs/5.7/testing)


## Fork
You would fork [web-api](https://github.com/indiehd/web-api) if you want to contribute to the server side Api.

Just click the `Fork` button in the top right of the repository page:

![](../images/fork_button.jpg)

Once forked, you will then `clone` ***YOUR*** repository to your local machine.

## Clone via HTTPS

?> Replace `<YOU>` with your username or organization!

```
git clone https://github.com/<YOU>/web-api.git
```

## Clone via SSH

*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be
added to your github account*

?> Replace `<YOU>` with your username or organization!

```
git clone git@github.com:<YOU>/web-api.git
```

## Help
If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)
40 changes: 36 additions & 4 deletions website-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,48 @@ Just click the `Fork` button in the top right of the repository page:

![](../images/fork_button.jpg)

**Repository Responsibilities**
## Repository Duties

* Client side processing
* Ajax calls to server Api
* Realtime updates
* UI/UX
**Qualifications**

## Qualifications

* Javascript (Specifically [ES6](https://github.com/lukehoban/es6features#readme))
* [VueJS Framework](https://vuejs.org/v2/guide/)
* Familiarity with [JavaScript Airbnb Style](https://github.com/airbnb/javascript/)
* Familiarity with [ESLint](https://eslint.org/docs/user-guide/getting-started)
* Familiarity with [ESLint](https://eslint.org/docs/user-guide/getting-started)

## Fork
You would fork [website-ui](https://github.com/indiehd/website-ui) if you want to contribute to the frontend.

Just click the `Fork` button in the top right of the repository page:

![](../images/fork_button.jpg)

Once forked, you will then `clone` ***YOUR*** repository to your local machine.

## Clone via HTTPS

?> Replace `<YOU>` with your username or organization!

```
git clone https://github.com/<YOU>/website-ui.git
```

## Clone via SSH

*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be
added to your github account*

?> Replace `<YOU>` with your username or organization!

```
git clone git@github.com:<YOU>/website-ui.git
```


## Help
If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)