Issue Template Plugin

Introduction #

The Issue Template Plugin is a powerful tool that allows you to define standardized templates for creating issues in your project. By using this plugin, you can ensure that all issues created follow a consistent structure and include the necessary information for effective communication and problem-solving.

Version Compatibility #

Redmine Versions

• 4.0.x, 4.1.x, 4.2.x
• 5.0.x
• 6.0.x(coming soon)

Installation #

To install Redmine Flux Issue Template Plugin follow these steps

1. Make sure you have a working installation of Redmine.
2. Download the Issue Template Plugin from the redmineflux.com website. The plugin typically comes in the form of a ZIP file
3. Extract the Issue Template Plugin zip file to Redmine’s plugins directory (/path/to/redmine/plugins) and do not change the plugin folder name.
4. Run the following command to install the required dependencies
   Bundle install 
5. Run migrate command for database migration  
   -> In Production 
   RAILS_ENV=Production bundle exec rails redmine:plugins:migrate
   –> In Development
      RAILS_ENV=Development bundle exec rails redmine:plugins:migrate 
6. Restart Redmine server to load the plugin 
   Rails s

Configuration #

• For Global Issue template

1. Log in to Redmine as an administrator.
2. Navigate to the administration area by clicking on the “Administration” link in the top menu.
3. Locate the “Issue Template” section and click on it.
4. Display the issue template page where users can add new templates, submit templates, edit existing ones, and delete templates.

• For Particular Project Issue Template

1. Login to Redmine using your credentials. 
2. Navigate to the header tab and click on the“Project” tab.
3. Open the particular project where you want to add the templates.
4. Navigate to the header tab and click on the “Issue Template” tab.
5. Display the issue template page where users can add new templates, submit templates, edit existing ones, and delete templates for particular projects.

How to #

How to Create the Global Issue Template #

1. Navigate to the administration area by clicking on the “Administration” link in the top menu.
2. Locate the “Issue Template” section and click on it.
3. Go to the issue template page.
4. Click on the “Add Issue Template” button.
5. Fill in the required fields such as “Tracker”, “Issue Template Name”, “Issue Subject”, “Issue description”, and “Project list” to select the project to use the template.
6. After filling in the necessary information, click on the submit button to save the template.
7. Additionally, the template should include a clear button to reset the form and a cancel button to discard the template without saving it.
8. Global Issue Template Page displaying only those templates that have been created by the administrator . 
   
   

How to Create the Particular Project Issue Template #

1. Navigate to the header tab and click on the “Project” tab.
2. Open the particular project where you want to add the templates.
3. Navigate to the header tab and click on the “Issue Template” tab.
4. Go to the issue template page.
5. Click on the “Add Issue Template” button.
6. Fill in the required fields such as “Tracker”, “Issue Template Name”, “Issue Subject”, “Issue description”, and “Project list” to select the project to use the template.
7. After filling in the necessary information, click on the submit button to save the template.
8. Additionally, the template should include a clear button to reset the form and a cancel button to discard the template without saving it.
9. Restrict the projects list in the issue template creation form to display only the projects for which the user is a member.
10. Project Issue Template Page displaying the issue templates included in the project, showcasing both project-specific templates and global issue templates. 
    
    

How to Edit the Issue Template #

1. Navigate to the “Issue Template” tab.
2. Display the list of created templates.
3. Find the template you want to edit and click on the edit icon (pencil icon).
4. You will be directed to the edit or update Issue template page.
5. Make the necessary changes to the fields you want to modify.
6. Submit the updated template to save your changes.
   
   

How to Delete the Issue Template #

1. Navigate to the “Issue Template” tab.
2. Display the list of created templates.
3. Find the template that you want to delete from the list and click on the trash icon(delete icon).
4. A confirmation dialog may appear asking you to confirm the deletion.
5. Confirm the deletion by clicking on “Yes” or “OK”.
6. The selected template will be removed from the list.
   
   

How to Use the Issue Template #

1. Navigate to the header tab and click on the “Issue” tab.
2. Click on the “New Issue” button.
3. Go to the create new issue page.
4. The system will automatically pre-select the default issue template according to the tracker. 
5. Click on the create button to create the issue.
   
   

Troubleshooting #

1. Check Compatibility: Ensure that you are using a compatible version of the Redmine Flux Issue Template Plugin with your Redmine installation. Verify the plugin’s compatibility information and ensure it matches your Redmine version.
2. Plugin Conflicts: Check for any conflicts with other installed plugins. Disable or uninstall conflicting plugins to see if the issue persists.
3. Clear Caches: Clear Redmine’s caches by restarting the application or using any available cache clearing mechanisms.
4. Community Support: Seek assistance from the Redmine community forums, plugin developers, or the official plugin repository for additional support and guidance.

Frequently Asked Questions (FAQs) #

Q1: What is the Issue Template Plugin?
A1: The Issue Template Plugin is a tool that allows you to define standardized templates for creating issues in your project. It ensures that all issues follow a consistent structure and include the necessary information for effective communication and problem-solving.

Q2: What is the purpose of the Issue Template Plugin?
A2: The Issue Template Plugin is designed to standardize the creation of issues in your project by providing predefined templates. It ensures that all issues follow a consistent structure and include the necessary information for effective communication and problem-solving.

Q3: Can I delete an existing issue template?
A3: Yes, you can delete an issue template if it’s no longer needed. Access the plugin’s configuration settings, locate the template you want to delete, and use the provided delete or remove option to remove it from the list.

Q4: Are there any validation options available for template fields?
A4: Yes, the plugin may offer template validation options. You can define mandatory fields or set up validation rules to ensure that users provide the necessary information when creating an issue using a specific template.

Q5: Can I update or modify existing issue templates?
A5: Yes, you can typically update or modify existing issue templates. Go to the issue template page, click on the edit or modify templates. From there, you can make changes to the template’s title, description, or fields.

Q6: Is it possible to assign templates to specific projects?
A6: Yes, it is possible to assign templates to specific projects using the Issue Template Plugin.
1. Go to the Issue template page, and edit the template.
2. You will be directed to the “Edit or Update Issue Template” page.
3. Update the “Project List” field by checking the checkboxes or selecting the projects.

Q.7 How does the pre-selected default issue template functionality work? 
A7: When creating a new issue, the plugin automatically sets a default template according to the specified tracker. This streamlines the issue creation process and ensures that the appropriate template is pre-selected. 

Q.8 How does the project filter functionality work ? 
A7: The project filter functionality enhances the Issue Template form’s project selection by implementing an auto-scroll feature in the project list. When a user presses any key, the project list automatically scrolls down and renders projects whose names begin with the pressed key. 

Uninstallation of Plugin  #

To uninstall the Redmine Flux  Issue Template Plugin, follow these steps

1. Go to the  Issue Template Plugin directory in Redmine. 
2. Delete the entire  Issue Template Plugin directory from Redmine/plugins directory. This step removes the plugin files from your Redmine installation. 
3. If the plugin required a migration, run the following command to downgrade your database (make a db backup before): 
   bundle exec rake redmine:plugins:migrate NAME=plugin_name VERSION=0 RAILS_ENV=production
4. Restart the Redmine server to see the changes. 
5. This will uninstall the Redmine Flux  Issue Template Plugin from Redmine. 

Updates and Revisions  #

• Plugin Updates: Keep track of plugin updates and new releases. Visit the official plugin website, plugin repository, Plugin updates may include bug fixes, performance improvements, or new features related to tag management.
• Documentation Revisions: Regularly review the plugin’s official documentation for any revisions or updates. Documentation may be revised to reflect changes in the plugin’s functionality, configuration options, or integration with the latest versions of Redmine.
• Testing and Compatibility: Before updating the plugin or making any significant changes to your Redmine instance, consider testing the changes in a development or staging environment. This allows you to verify compatibility with your specific Redmine version, check the impact on existing tags and data, and ensure a smooth transition.

Conclusion  #

The Issue Template Plugin provides a straightforward and efficient way to enforce consistent issue creation within your project. By defining templates, filling in template variables, and following the provided guidelines, you can ensure that all issues contain the necessary information for effective collaboration.