Development Guide

SourceTraq Development Guidelines and Coding Practices

Contributing to SourceTraq

Before diving into development, please review the Contribution Guidelines to ensure a seamless collaboration experience.

Starting the Development Process

To kickstart your development journey, follow these steps:

  1. Familiarize yourself with the Contribution Guidelines.
  2. If you're planning to develop a new module, create a detailed issue and await approval from Shridhar TL.
  3. Assign the relevant GitHub issue to yourself and maintain its status.
  4. Create a new branch from the 'develop' branch and include informative commit comments.
  5. Regularly sync your branch with 'develop' to facilitate merging later.

Setting Up Your Local Development Environment

Cloning and Preparing SourceTraq Sources

Refer Code Setup document to set up and run SourceTraq locally.

Creating a Free Cloud Instance for Development

For effective development, you can utilize cloud-based repositories like BitBucket, GitHub, or GitLab. These platforms typically offer free tiers that are suitable for individual or small team use. To enhance your development experience with SourceTraq, you can also reach out to Shridhar TL for access to shared resources. For more information or to create your own account:

Setting Up a BitBucket Container for Local Development (30 Days Trail)

Docker simplifies the process of running a BitBucket instance locally. Use the following command to set up a Docker container:

Note: This command will download several gigabytes of data for container setup.

docker pull atlassian/bitbucket-server
docker volume create --name bitbucketVolume
docker run -v bitbucketVolume:/var/atlassian/application-data/bitbucket --name="bitbucket" -d -p 7990:7990 atlassian/bitbucket-server

For subsequent development sessions, simply start the existing container with:

docker start bitbucket

Access your local BitBucket instance by opening http://localhost:7990 in your browser and following the setup instructions.

Setting Up Other Repository Cloud Instances

Similar to BitBucket, both GitHub and GitLab offer cloud instances. Make sure you have your development account created to begin collaboration on SourceTraq. For any assistance regarding integrations or best practices, feel free to reach out.