Skip to content
Open
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
33 changes: 33 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Sponsorship and Funding

Support the SmartContractAudit project through the following platforms:

## Sponsorship Options

### GitHub Sponsors
[GitHub Sponsors placeholder - to be configured]

### OpenCollective
[OpenCollective placeholder - to be configured]

## Why Sponsor?

Your sponsorship helps us:
- Maintain and improve the project
- Provide faster support and bug fixes
- Develop new features
- Cover infrastructure costs
- Support the open-source community

## Benefits

Sponsors receive benefits based on their tier. See [docs/partners/sponsorship_tiers.md](../docs/partners/sponsorship_tiers.md) for details.

## Other Ways to Support

- Contribute code or documentation
- Report bugs and security issues
- Share the project with others
- Provide feedback and suggestions

Thank you for supporting open source!
Comment on lines +1 to +33
Copy link

Copilot AI Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.github/FUNDING.yml is not in the format GitHub expects for displaying sponsor buttons (it should be a YAML mapping with keys like github:, open_collective:, custom:). As written (Markdown headings/paragraphs), GitHub will ignore it, so the intended sponsorship links won’t appear. Convert this file to the standard FUNDING.yml schema and move explanatory text to separate docs (e.g., docs/partners/).

Suggested change
# Sponsorship and Funding
Support the SmartContractAudit project through the following platforms:
## Sponsorship Options
### GitHub Sponsors
[GitHub Sponsors placeholder - to be configured]
### OpenCollective
[OpenCollective placeholder - to be configured]
## Why Sponsor?
Your sponsorship helps us:
- Maintain and improve the project
- Provide faster support and bug fixes
- Develop new features
- Cover infrastructure costs
- Support the open-source community
## Benefits
Sponsors receive benefits based on their tier. See [docs/partners/sponsorship_tiers.md](../docs/partners/sponsorship_tiers.md) for details.
## Other Ways to Support
- Contribute code or documentation
- Report bugs and security issues
- Share the project with others
- Provide feedback and suggestions
Thank you for supporting open source!
github: []
open_collective: ""
custom: []

Copilot uses AI. Check for mistakes.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Issue Template

Thank you for opening an issue! Please provide as much detail as possible to help us understand and address your concern.

## Issue Type

Please select one:
- [ ] Bug Report
- [ ] Feature Request
- [ ] Documentation Issue
- [ ] Security Vulnerability (please report via [SECURITY.md](../SECURITY.md) instead)
- [ ] Question

---

## Bug Report

### Description
A clear and concise description of the bug.

### Steps to Reproduce
1. Go to '...'
2. Run '...'
3. See error

### Expected Behavior
What you expected to happen.

### Actual Behavior
What actually happened.

### Environment
- OS: [e.g., Ubuntu 22.04]
- Version: [e.g., v1.0.0]
- Node version: [e.g., 18.x]
- Other relevant details:

### Logs/Screenshots
If applicable, add logs or screenshots to help explain the problem.

### Additional Context
Any other context about the problem.

---

## Feature Request

### Problem Statement
Describe the problem or need this feature would address.

### Proposed Solution
Describe your proposed solution or feature.

### Alternatives Considered
Describe any alternative solutions you've considered.

### Additional Context
Any other context, mockups, or examples.

---

## Documentation Issue

### Location
Link to the documentation page or file.

### Issue
Describe what is unclear, incorrect, or missing.

### Suggested Improvement
How should the documentation be improved?

---

## Question

### Your Question
Ask your question here.

### Context
Provide any relevant context or what you've already tried.

---

## Checklist

Before submitting, please:
- [ ] Search existing issues to avoid duplicates
- [ ] Provide all requested information
- [ ] Use a clear and descriptive title
- [ ] Add appropriate labels (if you have permission)
113 changes: 113 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Pull Request Template

## Description

Brief description of the changes in this PR.

## Type of Change

Please check the relevant option:

- [ ] Bug fix (non-breaking change fixing an issue)
- [ ] New feature (non-breaking change adding functionality)
- [ ] Breaking change (fix or feature causing existing functionality to change)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test improvement

## Safety Checklist

**IMPORTANT**: Please verify before submitting:

- [ ] **DRY_RUN verified**: All potentially destructive operations default to DRY_RUN=true
- [ ] **No secrets committed**: No API keys, private keys, passwords, or sensitive data in code
- [ ] **No hardcoded credentials**: All credentials use environment variables or secure secrets
- [ ] **Artifacts reviewed**: All generated artifacts (logs, reports) reviewed and safe to commit
- [ ] **Non-destructive by default**: Auto-apply and auto-merge features disabled by default
- [ ] **Permissions reviewed**: Required permissions are minimal and explicitly documented

## Audit Artifacts Section

If this PR includes security scanning or audit features:

### Artifacts Generated
- [ ] SMARTBRAIN.log
- [ ] AUDIT-REPORT.md
- [ ] .quarantine/ directory
- [ ] Other (specify):

### Artifact Safety
- [ ] Artifacts do not contain secrets or sensitive data
- [ ] Artifacts are properly gitignored or sanitized
- [ ] Redaction policy followed for any included artifacts

## Testing

- [ ] Tests pass locally
- [ ] New tests added for new functionality
- [ ] Existing tests updated if needed
- [ ] Manual testing completed

### Test Commands Run
```bash
# List commands you ran to test
```

## Changes Made

### Files Changed
- List key files and why they were changed

### Configuration Changes
- Any new environment variables?
- Any new dependencies?
- Any configuration file changes?

## Security Considerations

- [ ] No new security vulnerabilities introduced
- [ ] Security best practices followed
- [ ] Input validation added where necessary
- [ ] Output sanitization applied where necessary

## Documentation

- [ ] README updated (if needed)
- [ ] Code comments added for complex logic
- [ ] API documentation updated (if applicable)
- [ ] CHANGELOG updated (for releases)

## Checklist

- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Commits are signed off (DCO)
- [ ] PR title is clear and descriptive
- [ ] Linked related issues (closes #123, relates to #456)

## Additional Notes

Any additional context, decisions, or considerations for reviewers.

## Screenshots (if applicable)

Add screenshots for UI changes or visual features.

## Rollback Plan

If this is a significant change, describe how to roll back if issues arise:

```
Steps to rollback:
1.
2.
```

---

**For Reviewers:**
- [ ] Code quality approved
- [ ] Security implications reviewed
- [ ] Tests are adequate
- [ ] Documentation is clear
Loading