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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug report
description: Report a reproducible bug to help us improve Bridge.
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug.
- type: textarea
id: summary
attributes:
label: Bug summary
description: A short description of the problem.
placeholder: What happened?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Provide clear, minimal reproduction steps.
placeholder: |
1. Run ...
2. Configure ...
3. Observe ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
placeholder: What should have happened?
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs or output
description: Paste relevant logs, stack traces, or command output.
render: shell
- type: input
id: version
attributes:
label: Bridge version
placeholder: e.g. v0.1.0
- type: input
id: os
attributes:
label: Operating system
placeholder: e.g. Ubuntu 24.04
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability report
url: https://github.com/Penivera/Bridge/security/advisories/new
about: Please report security vulnerabilities privately using GitHub advisories.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature request
description: Suggest an idea or improvement for Bridge.
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for suggesting an improvement.
- type: textarea
id: problem
attributes:
label: Problem statement
description: What problem would this feature solve?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe the behavior or interface you'd like to see.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: What other approaches did you evaluate?
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any related links, examples, or notes.
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Summary
Describe the purpose of this pull request and the problem it solves.

## Changes
- List the main changes made in this PR.
- Include relevant modules, configs, or docs updates.

## Validation
Describe how you validated these changes.
- [ ] `cargo test`
- [ ] `cargo clippy --all-targets --all-features`
- [ ] Other (describe below)

## Checklist
- [ ] I have tested my changes locally
- [ ] I have updated documentation where relevant
- [ ] I have considered security and backward compatibility impact
30 changes: 30 additions & 0 deletions ACCESSIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Accessibility Guidelines

Bridge welcomes contributions that improve accessibility across documentation, website content, and tooling interfaces.

## Documentation Accessibility

- Use clear, direct language.
- Structure content with logical heading levels.
- Include descriptive link text.
- Provide alt text for meaningful images and diagrams.
- Avoid relying only on color to convey meaning.

## Website and UI Contributions

When contributing to web-facing content, aim to:

- Keep sufficient text/background contrast.
- Ensure keyboard-accessible navigation and controls.
- Associate labels with interactive elements.
- Preserve visible focus indicators.
- Validate semantic HTML structure.

## Reporting Accessibility Issues

If you find an accessibility issue, open an issue using the repository templates and include:

- Where the issue appears
- Steps to reproduce
- Expected accessible behavior
- Suggested improvement (if known)
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to Bridge

Thanks for your interest in contributing to Bridge.

## Getting Started

1. Fork the repository and create a branch for your change.
2. Keep changes focused and include tests when behavior changes.
3. Run checks locally before opening a pull request.

## Local Development

```bash
cargo fmt --all
cargo clippy --all-targets --all-features -- -D warnings
cargo test
```

## Pull Request Guidelines

- Use clear commit messages.
- Explain the intent and scope of your PR.
- Reference related issues when applicable.
- Update documentation for user-facing or operational changes.

## Code Standards

- Follow idiomatic Rust and existing project patterns.
- Prefer small, reviewable pull requests.
- Avoid introducing breaking changes without prior discussion.

## Community Conduct

Be respectful and constructive in all interactions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,14 @@ Comprehensive guides, configuration references, and operational architecture doc

---

### Community & Security

* [Contributing Guidelines](CONTRIBUTING.md)
* [Accessibility Guidelines](ACCESSIBILITY.md)
* [Security Policy](SECURITY.md)

---

### License

BRIDGE is dual-licensed under your choice of:
Expand Down
21 changes: 21 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security Policy

## Supported Versions

Security updates are provided for the latest release on the `main` branch.
When possible, fixes may be backported to recent releases.

## Reporting a Vulnerability

Please do **not** open a public issue for security vulnerabilities.

Report vulnerabilities privately through GitHub Security Advisories:
- https://github.com/Penivera/Bridge/security/advisories/new

Include as much detail as possible:
- Affected version(s)
- Impact and severity
- Reproduction steps or proof of concept
- Suggested remediation (if known)

We will acknowledge valid reports as quickly as possible and coordinate disclosure after a fix is available.