Contribution Guide

SourceTraq Contribution Guidelines and Coding Practices

How to Contribute

We appreciate your interest in enhancing SourceTraq! Your contributions are vital in making this tool better for developers around the globe.

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

  1. Start by creating a detailed issue on GitHub and assign it to Shridhar TL. This will facilitate a smooth transition when you submit a pull request.
  2. Ensure your contributions are browser-compatible and beneficial for all users. Avoid implementing features that cater to specific requirements.

Where Can You Make a Difference?

Your input can make a significant impact in several areas:

  • Comprehensively documenting existing features to reduce user inquiries.
  • Expanding the FAQ section by adding new questions, use cases, and scenarios.
  • Systematically testing features and accurately reporting bugs with clear reproduction steps.
  • Improving project reliability by writing tests for various components and features.
  • Suggesting new feature ideas and enhancements through GitHub issues.
  • Engaging in discussions for specific requirements outlined below.

Identifying Areas of Improvement

If you wish to lend your analytical skills, here are some areas that could benefit from your expertise:

  • Creating a streamlined API for reporting queries and bugs directly from SourceTraq.
  • Exploring integration possibilities with collaboration tools to enhance usability.
  • Investigating the potential for data visualization improvements, offering insights into repository performance.

Note: While aiming to address all criteria is ideal, focusing on the most critical areas is an excellent starting point.

Best Practices for Development

To align your contributions with the project's goals, adhere to the following guidelines:

  • Develop features that are universally beneficial for all users, irrespective of their specific setups.
  • Avoid dependencies on specific plugins or custom implementations.
  • Do not use proprietary or licensed components without appropriate permissions.
  • Address any issues or warnings before submitting your code.
  • Ensuring that your new additions do not interfere with the existing functionalities is crucial.
  • Providing documentation for your contributions is encouraged and can be included in the FAQ section.
  • Create unit tests for your contributions to enhance their reliability.

Setting Up the Development Environment

To begin your development journey, please refer to the Development Support Guide. This guide offers comprehensive instructions for setting up your local environment and kick-starting development.

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

We are grateful for your contributions and look forward to building an even more capable SourceTraq together. Your commitment enhances the experience for users worldwide.

Thank you for being a part of this project.