diff --git a/.github/CONTRIBUTING b/.github/CONTRIBUTING new file mode 100644 index 0000000..1fd93f8 --- /dev/null +++ b/.github/CONTRIBUTING @@ -0,0 +1,36 @@ +# Contributing to Aikido Safe Chain + +Thank you for your interest in contributing! Please discuss significant changes in an issue first to avoid duplication of work. + +## Reporting Issues + +Report issues on our [GitHub Issues page](https://github.com/AikidoSec/safe-chain). Check existing issues first and include: +- Steps to reproduce +- Expected vs actual behavior +- Environment details (Node.js version, OS, package manager) +- Relevant logs/errors + +## Contributing Code + +1. Fork and clone the repository +2. Create a descriptive branch name +3. Make your changes following the existing code style +4. Add tests for your changes +5. Run `npm test` and `npm run lint` +6. Push and create a pull request + +## Development + +**Setup:** +```bash +npm install +``` + +**Commands:** +- `npm test` - Run tests +- `npm run test:watch` - Watch mode +- `npm run lint` - Check code style + +**Requirements:** +- Node.js 18+ +- Follow .editorconfig formatting diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a64f50a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: Bug Report +description: Report a bug to help us improve +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the sections below to help us understand and reproduce the issue. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is + placeholder: Describe what happened and what you expected to happen + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Run command '...' + 2. Install package '...' + 3. See error + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Your system information + placeholder: | + - OS: [e.g. macOS 14.0, Ubuntu 22.04, Windows 11] + - Node.js version: [e.g. 18.17.0] + - Package manager: [e.g. npm 9.6.7, yarn 1.22.19, pnpm 8.6.0] + - Safe Chain version: [e.g. 1.0.0] + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Error Logs + description: Relevant error messages or logs + placeholder: Paste any error messages or logs here + render: shell + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any other context about the problem + placeholder: Screenshots, related issues, workarounds, etc. \ No newline at end of file