Andreas/tracks
1
0
Fork 0
mirror of https://github.com/TracksApp/tracks.git synced 2025-12-16 07:10:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docker improvements to better use existing tools

Browse source
This commit is contained in:
Matteo Giaccone 2018-12-06 23:04:06 +01:00
parent a15a7d8a95
commit fe9859d959
3 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -11,7 +11,7 @@ For example:
- tutorials on using Tracks (user manual)
## Issues
If you think having found a problem with Tracks, first search in the [existing issues]((https://github.com/TracksApp/tracks/issues). If you cannot find it, open a new issue and try providing information on your setup and what steps are needed to reproduce the problem.
If you think having found a problem with Tracks, first search in the [existing issues](https://github.com/TracksApp/tracks/issues). If you cannot find it, open a new issue and try providing information on your setup and what steps are needed to reproduce the problem.
## Enhancements
It would be great to first discuss them on the [mailing list](https://groups.google.com/group/TracksApp) so you can figure out if it could be merged or not. You may use the wiki too to describe your change if it is too big for an email.
@ -20,10 +20,12 @@ If you want to contribute an enhancement or a fix, you can:
1. [fork the project](https://help.github.com/articles/fork-a-repo)
1. [create a topic branch](http://learn.github.com/p/branching.html).
1. setup the project with [docker-compose](https://docs.docker.com/compose/) by running `docker-compose up`
1. then run `./bin/setup` to setup the first run
1. install [docker-compose](https://docs.docker.com/compose/)
1. copy `app/config/site.yml.tmpl` to `app/config/site.yml` and customize as needed
1. then with `./bin/setup` you will prepare for the first run
1. start the server with `./script/server` which will start everything you need in Docker and present Tracks at [http://0.0.0.0:3000](http://0.0.0.0:3000)
1. if you need, you can launch a Rails console with `./bin/rails c` (will run inside Docker)
1. make your changes and adds/updates relevant tests.
1. make your changes and add/update relevant tests
1. run the test suite with `./bin/rake test` (will run inside Docker)
1. commit the changes
1. send a pull request.