|
| 1 | +# GitHub Copilot Instructions for CryptoAttacker/tools |
| 2 | + |
| 3 | +This repository contains documentation and information about cryptocurrency recovery and security tools. |
| 4 | + |
| 5 | +## Repository Structure |
| 6 | + |
| 7 | +- `index.md`: Main documentation file containing links to various cryptocurrency tools and tutorials |
| 8 | +- `.github/`: GitHub configuration and documentation files |
| 9 | + |
| 10 | +## Documentation Standards |
| 11 | + |
| 12 | +### Markdown Formatting |
| 13 | +- Use proper markdown syntax for all documentation files |
| 14 | +- Headers should follow hierarchical structure (H1 for main title, H2 for sections, H3 for subsections) |
| 15 | +- Use bullet points for lists |
| 16 | +- Include descriptive link text with URLs in markdown format: `[Link Text](URL)` |
| 17 | + |
| 18 | +### Content Guidelines |
| 19 | +- Keep documentation clear and concise |
| 20 | +- Provide accurate descriptions for all tools and software listed |
| 21 | +- Include relevant metadata such as version numbers when available |
| 22 | +- Ensure all external links are properly formatted and functional |
| 23 | + |
| 24 | +### Link Formatting |
| 25 | +- Use markdown link syntax: `[Link Text](URL 'Optional Title')` |
| 26 | +- Include descriptive titles in link attributes when appropriate |
| 27 | +- Verify all URLs are valid before committing |
| 28 | + |
| 29 | +## Code Changes |
| 30 | + |
| 31 | +### General Principles |
| 32 | +- Make minimal, focused changes |
| 33 | +- Preserve existing structure and formatting unless specifically requested to change it |
| 34 | +- Maintain consistency with existing code style |
| 35 | + |
| 36 | +### Documentation Updates |
| 37 | +- When updating index.md or other documentation files, maintain the existing structure |
| 38 | +- Keep the format consistent with existing entries |
| 39 | +- Ensure proper escaping of HTML entities in markdown files |
| 40 | + |
| 41 | +## Testing and Validation |
| 42 | + |
| 43 | +### Documentation |
| 44 | +- Preview markdown files to ensure proper rendering |
| 45 | +- Verify all links are functional |
| 46 | +- Check for proper formatting of special characters |
| 47 | + |
| 48 | +### File Management |
| 49 | +- Do not add unnecessary files to the repository |
| 50 | +- Exclude build artifacts and temporary files using `.gitignore` |
| 51 | +- Keep the repository clean and organized |
| 52 | + |
| 53 | +## Security Considerations |
| 54 | + |
| 55 | +- Do not include sensitive information such as private keys, passwords, or API credentials |
| 56 | +- Be mindful that this repository contains information about security tools |
| 57 | +- Ensure all content is appropriate for public repositories |
| 58 | + |
| 59 | +## Commit Guidelines |
| 60 | + |
| 61 | +- Write clear, descriptive commit messages |
| 62 | +- Keep commits focused on single logical changes |
| 63 | +- Reference issue numbers when applicable |
| 64 | + |
| 65 | +## Pull Request Best Practices |
| 66 | + |
| 67 | +- Provide clear descriptions of changes made |
| 68 | +- Include context for why changes were necessary |
| 69 | +- List any testing or verification performed |
0 commit comments