Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SRCT
go
Commits
d32b7c03
Unverified
Commit
d32b7c03
authored
Mar 28, 2017
by
David Haynes
Browse files
Add documentation on how to run unit testing (Closes
#43
)
- docker currently not supported for running unit testing /shrug
parent
0809e74a
Pipeline
#1162
passed with stage
in 1 minute and 4 seconds
Changes
1
Pipelines
3
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
d32b7c03
...
...
@@ -177,6 +177,39 @@ https://git.gmu.edu/srct/go/wikis/manual-setup
# Some words about contributing to Go.
## 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:
#### Docker
Docker is not supported currently for running unit tests. If you're able to get
it set up, open a merge request and I'll merge it in.
#### Vagrant
vagrant up
vagrant ssh
cd /vagrant
source venv/bin/activate
cd go
python manage.py test
#### Manual Setup
Assuming you are within your virtualenv:
python manage.py test
## CONTRIBUTING.md
This document goes into detail about how to contribute to the repo, plus some
...
...
@@ -198,6 +231,7 @@ Once in the admin page go to "registered users", and create a new registered use
use the same username and Full Name as your main account and select "approved" in the bottom row.
## Coding style
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.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment