Contribution Guide

Jira Assistant Contribution Guidelines and Coding Practices

How to Contribute

Thank you for your interest in contributing to the development of Jira Assistant. Your contributions are invaluable in enhancing this tool for users around the world.

The develop branch contains the latest code. To contribute effectively, follow these steps:

  1. Start by creating a detailed issue on GitHub, and assign it to Shridhar TL. This practice ensures a smooth transition when you create a pull request.
  2. Maintain a universal approach – your changes should be browser-agnostic and beneficial for all users. Avoid implementing features tailored to specific needs.

Where Can You Make a Difference?

There are several areas where your input can make a significant impact:

  • Documenting the existing features comprehensively to reduce user inquiries.
  • Expanding the FAQ module by adding new questions and scenarios.
  • Rigorously testing existing features and accurately reporting bugs, including clear reproduction steps.
  • Strengthening the stability of the project by writing tests for components/pages.
  • Proposing new feature ideas and requirements via GitHub issues.
  • Participating in the analysis of specific requirements listed below.

Analyzing Outstanding Requirements

For those who wish to contribute analytically, here are some ongoing requirements that could benefit from your expertise:

  • Creating a free web service/API for submitting queries and bugs directly from Jira Assistant.
  • Exploring calendar integration possibilities with both Outlook and Jira.
  • Investigating the feasibility of a web service/API providing holiday-related information.

Note: While fulfilling all the criteria is ideal, addressing the most crucial aspects is a great starting point.

Best Practices for Development

To ensure your contributions align seamlessly with the project's goals, follow these guidelines:

  • Develop modules that cater to the broader user base, irrespective of their Jira version.
  • Refrain from dependencies on specific plugins or custom fields in Jira.
  • Avoid utilizing non-open-source components or libraries.
  • Resolve any issues or warnings before submitting your code.
  • Verify that your new additions do not disrupt existing functionality.
  • Optionally, offer documentation for your module, which can also be integrated into the FAQ section.
  • While not mandatory, creating unit tests for your module enhances its quality.

Setting Up the Development Environment

To initiate your development journey, refer to the Development Support Guide. This guide provides comprehensive instructions for configuring your local environment and commencing development.

For the final stages of testing and publishing, consult the Publishing Guidelines.

We sincerely appreciate your contributions and look forward to building an even more impressive Jira Assistant together. Your dedication strengthens this tool for users worldwide.

Thank you for your commitment to this project.