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)

Jyri-Petteri Paloposki 2020-07-17 13:09:53 +03:00
parent e176755103
commit 0383bcfde3
1 changed files with 3 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

28
How-to-contribute.md

@ -1,34 +1,12 @@
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 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).
* 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:
<pre>
<code>
mkdir ~/dev/tracks
cd ~/dev/tracks
git clone git://github.com/TracksApp/tracks.git
</code>
</pre>
Or you can sign up for a free account on github and fork Tracks using the convenient button.
* Bugfixes, enhancements: pull requests. <BR>We review pull requests on Github.
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':
<pre>
<code>
git diff master..experiment > my_feature.patch
</code>
</pre>
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 (when!) you produce a cool new feature or fix a bug, create a pull request using the instructions in "GitHub manual":https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests 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).
Thanks!