CONTRIBUTING.md

Contributing to Subconverter

Welcome, and thank you for your interest in contributing to subconverter!

Reporting Issues

• Check if the issue already exists.
• Use the issue template to create a new issue.
• Be as detailed as possible.

Feature Requests

• Check the feature doesn't already exist.
• Use the feature request template to submit a new request.

Pull Requests

• Fork the repository.
• Create a new branch for your changes.
• Follow the coding style and guidelines.
• Test the features as much as you can.
• Update the documentation as needed.
• Submit a pull request with a detailed description of your changes.

Setting Up Your Development Environment

To contribute to Subconverter, you'll need to set up your development environment. Here's a brief overview:

Windows Build Instructions

1. install the prerequisites: for example if you are using msys2 and mingw-w64 for compilation:

pacman -S base-devel git mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake mingw-w64-x86_64-pcre2 patch python

2. run script to initialize the project for development:

sh scripts/build.windows.dev.sh

3. debug the project with GDB:

gdb ./subconverter/subconverter.exe

or use VSCode with the following configuration:

{
    "name": "C/C++: g++.exe build and debug active file",
    "type": "cppdbg",
    "request": "launch",
    "program": "${workspaceFolder}/subconverter/subconverter.exe",
    "args": [],
    "stopAtEntry": false,
    "cwd": "${workspaceFolder}/subconverter/",
    "environment": [],
    "externalConsole": true,
    "MIMode": "gdb",
    "miDebuggerPath": "C:\\msys64\\mingw64\\bin\\gdb.exe",
    "setupCommands": [
        {
        "description": "Enable pretty-printing for gdb",
        "text": "-enable-pretty-printing",
        "ignoreFailures": true
        },
        {
        "description": "Set Disassembly Flavor to Intel",
        "text": "-gdb-set disassembly-flavor intel",
        "ignoreFailures": true
        }
    ],
}

4. increamental build during development:

make -j4 && cp subconverter.exe subconverter/subconverter.exe

macOS

1. install the prerequisites:

You should install all the following prequisites via your package manager.

• cmake
• pcre2
• patch
• python

for macos run

brew reinstall rapidjson zlib pcre2 pkgconfig

1. run the script to initialize the project for development:

sh scripts/build.macos.dev.sh

2. increamental build during development:

make -j && cp subconverter subconverter/subconverter

3. run the executable for test:

./subconverter

Thank you for contributing to subconverter!