We have an issue tracker set up at bugs.goldencheetah.org. Below are some guidelines for users and developers for working with the issue tracker.

Report a new bug/feature

If you think that you have found a bug in GoldenCheetah or would like to request a new feature please report it by filing a new issue at our issue tracker. To report a bug/feature request go to the above link and follow these steps:

1. Login or register for a new account.
2. Click the "new issue" link near the top of the page.
3. Select either "bug" or "feature" from the tracker drop-down menu.
4. Fill out the form including as much detail as possible.
   You can upload crashreports, problem files, or screenshots if they help document the issue.
5. Click the create button to save your report.
   This will also send a copy of your report to the Golden-Cheetah-Users mailing list.

Thanks for helping to improve GoldenCheetah.

Managing issues in the tracker

To make it easier for all of us to track the status please try to adhere to a few simple guidelines listed below.

Issue Status:

Depending on your account status (non-member, reporter, developer, or manager) you may be able to update the status of an existing issue. When working in the bug tracker please update the status appropriately. Current status options are:

- New: Default status.

- Assigned: issue has been assigned to someone on the project. If you are a Developer you can assign an issue to someone, including yourself. If you are working on a fix, please change the status to Assigned, and post a message stating your plan of attack etc.

- Feedback: This could be used to alert others that you have a proposed fix that you want feed back on. Please attach patches and make a note. Also remember to tag the issue in your patches.

- Resolved: The issue has been corrected. People that have tested the patch or that submitted the bug should update to this status when they feel that it has been fixed. If it turns out that it was not resolved, most users can change the status back to "feedback". If you do so, please leave a note.

- Tempfix: A workaround for the issue has been posted, but we may still be working on a more long term solution.

- Closed: Those with commit access to Github are the only ones that can mark an issue as closed. That said, if you are submitting a patch that fixes and issue, please include the "fixes #<issuenum>" tag to your commit as this will automatically close the issue when your patch is accepted and pushed to github.

Tagging in messages

The tracker has a very basic tagging and markup scheme that is described in detail here. Perhaps the most useful feature is the ability to use tags to link issues, commits, etc. When commenting on an issue please use the following tags when appropriate to automatically create links when:

Tag | Effect
--- | ---
Issue #2 | Creates a link to existing Issue #2
commit:e76247a | Creates a link to commit e76247a
source:src/MainWindow.cpp | Creates a link to src/Mainwindow.cpp in our git repo