Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug Report
about: Report a bug
labels: bug
---

**Description**
A clear description of the bug.

**Steps to Reproduce**
1. Run `...`
2. ...

**Expected Behavior**
What you expected to happen.

**Actual Behavior**
What actually happened. Include any error output.

**Environment**
- OS:
- Go version:
- rsync version:
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature Request
about: Suggest a new feature or improvement
labels: enhancement
---

**Description**
A clear description of the feature or improvement.

**Use Case**
Why is this needed? What problem does it solve?

**Proposed Solution**
How you think it could work (optional).
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**Description**
What does this PR do?

**Related Issue**
Fixes #
4 changes: 2 additions & 2 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5

- name: Setup NodeJS
uses: actions/setup-node@v6
with:
node-version: 24.x

- name: Set up Go
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: '1.25'

Expand Down
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

Thanks for your interest in contributing to backup-rsync!

## Getting Started

1. Fork the repo and clone it
2. Install Go 1.25+ and `rsync`
3. Run `make build` to verify the setup

## Development Workflow

```sh
make format # Format code
make lint # Run linter
make test # Run unit tests
make test-integration # Run integration tests (requires rsync)
make check-coverage # Verify coverage threshold (98%)
```

## Submitting Changes

1. Create a branch from `main`
2. Make your changes — keep commits focused
3. Ensure `make lint` and `make test` pass
4. Open a pull request against `main`

## Guidelines

- Follow idiomatic Go conventions
- Add tests for new functionality
- Use dependency injection over global state
- Keep the CI green — all checks must pass before merge

## License

By contributing, you agree that your contributions will be licensed under the [GPL-3.0 License](LICENSE).
Loading