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

Updated How to contribute (markdown)

tedks 2014-09-21 17:39:10 -07:00
parent 457ca2072c
commit d3d2106262
1 changed files with 35 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

70
How-to-contribute.md

@ -1,36 +1,36 @@
All contributions are welcome. We like to see contributions like for example: All contributions are welcome. We like to see contributions like for example:
* Tutorials on installing Tracks in various environments. <BR>They can be added to the wiki on github * Tutorials on installing Tracks in various environments. <BR>They can be added to the wiki on github
* Tutorials on using Tracks (user manual). <BR>They can be added to the wiki on github * Tutorials on using Tracks (user manual). <BR>They can be added to the wiki on github
* Reporting issues you have with Tracks (bugs, enhancements). <BR>Please use Assembla for reporting issues, we do not use guthub for issue management * Reporting issues you have with Tracks (bugs, enhancements).
* Bugfixes, enhancements: pull requests. <BR>We review pull requests on github. For enhancements it would be great to first discuss them on the mailing list 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. * Bugfixes, enhancements: pull requests. <BR>We review pull requests on github. For enhancements it would be great to first discuss them on the mailing list 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.
To clone Tracks: To clone Tracks:
<pre> <pre>
<code> <code>
mkdir ~/dev/tracks mkdir ~/dev/tracks
cd ~/dev/tracks cd ~/dev/tracks
git clone git://github.com/TracksApp/tracks.git git clone git://github.com/TracksApp/tracks.git
</code> </code>
</pre> </pre>
Or you can sign up for a free account on github and fork Tracks using the convenient button. Or you can sign up for a free account on github and fork Tracks using the convenient button.
For help with running the tests, see [[https://github.com/TracksApp/tracks/wiki/Testing]] For help with running the tests, see [[https://github.com/TracksApp/tracks/wiki/Testing]]
If (when!) you produce a cool new feature or fix a bug, create a patch. If you develop in a branch called 'experiment': If (when!) you produce a cool new feature or fix a bug, create a patch. If you develop in a branch called 'experiment':
<pre> <pre>
<code> <code>
git diff master..experiment > my_feature.patch git diff master..experiment > my_feature.patch
</code> </code>
</pre> </pre>
Then attach my_feature.patch to a ticket. Then attach my_feature.patch to a ticket.
If you are on github, you can use the button to issue a pull request for your changes to be pulled into the main repository. Please try to write a useful and well-formatted commit message -- see some [formatting guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and [tips for integrating with the issue tracker](https://www.assembla.com/spaces/tracks-tickets/github_tool). If you are on github, you can use the button to issue a pull request for your changes to be pulled into the main repository. Please try to write a useful and well-formatted commit message -- see some [formatting guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and [tips for integrating with the issue tracker](https://www.assembla.com/spaces/tracks-tickets/github_tool).
If you've found a bug or got a feature to suggest, visit the Tracks [Assembla Space](http://www.assembla.com/spaces/tracks-tickets/) and create a ticket. You'll need to [create an account on Assembla](http://www.assembla.com/wiki/show/alWI9M0eWr3zoYab7jnrAJ). If you've found a bug or got a feature to suggest, visit the Tracks [Assembla Space](http://www.assembla.com/spaces/tracks-tickets/) and create a ticket. You'll need to [create an account on Assembla](http://www.assembla.com/wiki/show/alWI9M0eWr3zoYab7jnrAJ).
Thanks! Thanks!