README.md 2.5 KB
Newer Older
1
# Go 2
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2

Zac Wood's avatar
Zac Wood committed
3
[![build status](https://git.gmu.edu/srct/go/badges/master/build.svg)](https://git.gmu.edu/srct/go/commits/master) [![coverage report](https://git.gmu.edu/srct/go/badges/master/coverage.svg)](https://git.gmu.edu/srct/go/commits/master) [![python version](https://img.shields.io/badge/python-3.4+-blue.svg)]() [![Django version](https://img.shields.io/badge/Django-2.2-brightgreen.svg)]()
Jean Michel Rouly's avatar
Jean Michel Rouly committed
4

5

6
#### A project of [GMU SRCT](https://srct.gmu.edu).
7

David Haynes's avatar
David Haynes committed
8 9 10
Go is a drop-in URL shortening service. This project aims to provide an easy to use
URL branding service for institutions that wish to widely disseminate information
without unnecessarily outsourcing branding.
David Haynes's avatar
David Haynes committed
11

Zac Wood's avatar
Zac Wood committed
12
Go is currently a `Python 3` project written in the `Django` web framework, with
David Haynes's avatar
David Haynes committed
13
`MySQL` as our backend database.
14

David Haynes's avatar
David Haynes committed
15
# Setup instructions for local development
16

Zac Wood's avatar
Zac Wood committed
17 18 19 20
Go currently supports developers on Linux, macOS and Windows platforms. Please follow the setup instructions for your operating system:
- [Windows](https://git.gmu.edu/srct/go/-/wikis/Initial-Setup/Windows)
- [Mac](https://git.gmu.edu/srct/go/-/wikis/Initial-Setup/Mac)
- Linux (TODO. For now follow the Mac instructions with your disto's package manager instead of Homebrew)
David Haynes's avatar
David Haynes committed
21

David Haynes's avatar
David Haynes committed
22 23 24

# Some words about contributing to Go.

25 26 27 28 29 30 31 32 33 34 35 36 37
## Testing

You are _very strongly_ encouraged to write test cases where applicible for
code that you contribute to the repo. This is not a rule at the moment but rather
a strong suggestion. It's good practice for corporate land and will also ensure
your code works. Additionally, there are quite a few example ones to look at in
the repo and on Google.

### Running Unit Tests

Unit tests are run on every commit sent to gitlab though that can be a pain to
rely on. Here's how to run them locally:

38
## CONTRIBUTING.md
David Haynes's avatar
David Haynes committed
39

40 41 42 43 44 45 46 47 48
This document goes into detail about how to contribute to the repo, plus some
opinions about using `git`.

## Opening issues

There is a template for issue descriptions located on the new issue page. I will
close issues with poor descriptions or who do not follow the standard.

## Coding style
49

50 51 52 53 54
You should adhere to the style of the repo code. Consistancy is key! PEP8 guidelines
are strongly reccomended but not enforced at the time. Please comment your code,
I will not accept commits that contain uncommented code.

## Getting Help
David Haynes's avatar
David Haynes committed
55

David Haynes's avatar
David Haynes committed
56 57
I encourage you to join the [#go channel](https://srct.slack.com/messages/go/details/) in SRCT's [Slack Group](https://srct.slack.com)
if you have any questions on setup or would like to contribute.
David Haynes's avatar
David Haynes committed
58

David Haynes's avatar
David Haynes committed
59

David Haynes's avatar
David Haynes committed
60 61
---
**Note:**
David Haynes's avatar
David Haynes committed
62

63
Link by Viktor Vorobyev from the Noun Project.