Trac Ticket Guidelines
From Aptana Development
Some notes when writing up a Trac ticket:
Adding a New Ticket
- Make the title very descriptive. Ideally, it should be enough to ensure that a non-technical user can read and understand the problem being fixed, or the feature being added. For additional information, they can then see the summary.
- Use complete phrases, i.e. "Create Ubuntu Installer for Aptana IDE", rather than "Ubuntu installer"
- Unless you specifically know you will be working on that item, make sure that it does not have a default owner. You may need to submit the task and then modify the default owner after the fact.
- Ensure that the description is complete enough to detail what the requirements for the finished piece are. If this is not detailed enough, then add a relevant page to the wiki. The quality of a feature or bug fix is directly proportional to the quality of the requirements. It need not be lengthy, but simple, to the point, and perhaps with some references to other implementations.
- Assign a property severity
- Assign a proper component. If a component isn't listed, please email ingo@aptana.com to add it.
- Unless you know specifically it will appear in a certain milestone, leave the milestone field blank.
Working with Trac
- When you wish to start work on a Trac item, make sure you "assign" it to yourself, and "accept" the task.
- Once you are done with the task, close the task as "fixed" and add a complete description including the following:
- Changelist # of perforce containing the fix
- What was changed, modified or added to make the fix or add the feature. Remember, someone may use this later to figure out how this iem may have impacted other code, so give them a trail back to the source. Package names, class names, etc are all helpful here.
- If there are any known issues remaining, open a separate trac item for those, and reference them here. If you add a #ticket-number to a description, that will show as a link in trac.
- Remember to close the ticket within 5 minutes of submitting the change to perforce. Otherwise the release notes will not be correct. If you wish to close the ticket first, you can move your items into a numbered changelist in Perforce so you have a reference point.
Adding a Release Note
- If you add an item with component "release_notes" and mark it as closed, it will appear at the top of the list as a description for the milestone. There can be multiple release notes.


