Skip to content

docs: improve README, config reference, API docs, and contributing guide #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tinu-hareesswar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README, config reference, API docs, and contributing guide #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing to Decision Engine

Thank you for considering contributing to Decision Engine! This document provides guidelines and instructions for contributing.
Thank you for considering contributing to Decision Engine! This document describes how to report issues, propose changes, and submit pull requests.

## Code of Conduct

By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
Be respectful, constructive, and professional. We follow the spirit of the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). Unacceptable behaviour can be reported privately to `hyperswitch@juspay.in`.

## How Can I Contribute?

Expand Down Expand Up @@ -38,32 +38,29 @@ We welcome feature suggestions! Feature requests should include:

#### Development Environment Setup

For setting up the database, please refer to the following guides:
- **MySQL Setup**: [docs/setup-guide-mysql.md](docs/setup-guide-mysql.md)
- **PostgreSQL Setup**: [docs/setup-guide-postgres.md](docs/setup-guide-postgres.md)
The canonical local setup — CLI, Docker, Compose, and Helm — lives in [docs/local-setup.md](docs/local-setup.md). Database-specific quickstarts:

- **PostgreSQL**: [docs/setup-guide-postgres.md](docs/setup-guide-postgres.md)
- **MySQL**: [docs/setup-guide-mysql.md](docs/setup-guide-mysql.md)

```bash
# Clone your fork
git clone https://github.com/your-username/decision-engine.git
cd Decision Engine
git clone https://github.com/YOUR_USERNAME/decision-engine.git
cd decision-engine

# Add the upstream repository
git remote add upstream https://github.com/project-owner/decision-engine.git
# Track upstream
git remote add upstream https://github.com/juspay/decision-engine.git

# Create a branch
git checkout -b feature/your-feature-name
git checkout -b feat/your-feature-name

# Install development dependencies
# Recommended dev tooling
cargo install cargo-watch cargo-insta cargo-audit

# Run tests
# Run the test suite
cargo test

# Run specific tests
cargo test routing_test

# Run with auto-reload for development
# Auto-reload loop during development
cargo watch -x run
```

Expand Down
Loading
Loading