tracks/doc/README_DEVELOPERS

1. Resources

Tracks is using
* GitHub to host the git repository, manage git pull requests, and manage bugs and enhancement requests.
* the mailing list to discuss features and development and interact with users

See README for links to the respective sites

Also see the Development pages on the wiki for details on installing, testing,
upgrading, etc.

2. Dependencies

The dependencies for Tracks are maintained using bundler. Before starting your
tracks instance, you'll need to run 'bundle install' to fetch all the
dependencies

3. Testing

There are some pointers for setting up your Tracks copy for testing at
https://github.com/TracksApp/tracks/wiki/Testing/

By default, tests are configured to run using sqlite3 in memory mode to
increase speed. You will need the sqlite3-ruby gem for this.

To avoid showing the migrations as tests are run, add the following to your
database.yml below 'database: ":memory:"':

  verbosity: quiet

If you want to run tests using another database, that's fine, too. Just change
your database.yml accordingly.

Running cucumber/selenium tests in :memory mode does not seem to work.

The rspec tests are not actively maintained.

See the wiki for more information on testing:
https://github.com/TracksApp/tracks/wiki/Testing

4. Contributing

See https://github.com/TracksApp/tracks/wiki/How-to-contribute
update documentation for RC release 2010-08-19 16:34:42 +02:00			`1. Resources`

			`Tracks is using`
update documentation after move to GitHub 2014-07-05 12:31:32 +02:00			`* GitHub to host the git repository, manage git pull requests, and manage bugs and enhancement requests.`
Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`* the mailing list to discuss features and development and interact with users`
update documentation for RC release 2010-08-19 16:34:42 +02:00
			`See README for links to the respective sites`

update docs and default database from changes in 2.1 tree 2012-04-19 00:35:46 +02:00			`Also see the Development pages on the wiki for details on installing, testing,`
			`upgrading, etc.`
upgrade vendored rails to 2.3.14 2011-08-17 09:55:36 +02:00
update documentation for RC release 2010-08-19 16:34:42 +02:00			`2. Dependencies`

Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`The dependencies for Tracks are maintained using bundler. Before starting your`
			`tracks instance, you'll need to run 'bundle install' to fetch all the`
			`dependencies`
update documentation for RC release 2010-08-19 16:34:42 +02:00
update versioning for master 2012-04-03 15:49:24 +02:00			`3. Testing`
merge upstream changes 2008-06-19 10:13:59 +02:00
Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`There are some pointers for setting up your Tracks copy for testing at`
			`https://github.com/TracksApp/tracks/wiki/Testing/`
merge upstream changes 2008-06-19 10:13:59 +02:00
Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`By default, tests are configured to run using sqlite3 in memory mode to`
			`increase speed. You will need the sqlite3-ruby gem for this.`
merge upstream changes 2008-06-19 10:13:59 +02:00
Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`To avoid showing the migrations as tests are run, add the following to your`
			`database.yml below 'database: ":memory:"':`
merge upstream changes 2008-06-19 10:13:59 +02:00
			`verbosity: quiet`

Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00			`If you want to run tests using another database, that's fine, too. Just change`
			`your database.yml accordingly.`
merge upstream changes 2008-06-19 10:13:59 +02:00
update versioning for master 2012-04-03 15:49:24 +02:00			`Running cucumber/selenium tests in :memory mode does not seem to work.`
merge upstream changes 2008-06-19 10:13:59 +02:00
update versioning for master 2012-04-03 15:49:24 +02:00			`The rspec tests are not actively maintained.`
merge upstream changes 2008-06-19 10:13:59 +02:00
update docs and default database from changes in 2.1 tree 2012-04-19 00:35:46 +02:00			`See the wiki for more information on testing:`
			`https://github.com/TracksApp/tracks/wiki/Testing`
change urls to their new location in documentation 2011-07-27 15:39:47 +02:00
update versioning for master 2012-04-03 15:49:24 +02:00			`4. Contributing`
Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. 2011-10-24 12:34:11 -05:00
update versioning for master 2012-04-03 15:49:24 +02:00			`See https://github.com/TracksApp/tracks/wiki/How-to-contribute`