Contributing to Contentstack Bridge

Thank you for your interest in contributing to Contentstack Bridge! This document outlines the process for contributing to our CLI application.

Development Environment

Ensure you have Go installed (version 1.23 or higher).

Building and Running

Navigate to the project directory:
```
cd csb
```
Build the project:
```
go build -ldflags="-s -w"
```
Run the CLI application:
```
./csb
```

Coding Standards

Follow the Effective Go guidelines
Use gofmt to format your code
Write meaningful variable and function names
Maintain a consistent code style throughout the project

Testing

Write unit tests for new features or bug fixes using the built-in testing package
Assertions can be made with the github.com/stretchr/testify/assert package
Total test coverage must at least be 80%
Ensure all existing tests pass before submitting a pull request:
```
./scripts/test.sh
```

Submitting Changes

Fork the repository in GitHub

Clone the fork locally:

git clone [email protected]:[USERNAME]/csb.git

Create a new branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```
Commit your changes with a clear and descriptive commit message:
```
git commit -m "feat(code): your feature description"
```

Push your changes to your fork:

git push origin feature/your-feature-name

Create a pull request on GitHub from your fork to the main repository

Pull Request Guidelines

Provide a clear description of the changes in your pull request
Include any relevant issue numbers in the PR description
Ensure your PR passes all CI checks
Ideally link the PR to an open issue
Be prepared to make changes if requested by maintainers

Reporting Issues

Use the GitHub issue tracker to report bugs or suggest enhancements
Provide as much detail as possible, including steps to reproduce for bugs

Thank you for contributing to Contentstack Bridge!