From 956aafd700894f609e9d45defd6b3fe0ea310333 Mon Sep 17 00:00:00 2001 From: jagnd1 Date: Tue, 9 Dec 2025 00:17:09 +0530 Subject: [PATCH] Add security: CODEOWNERS and contributing guidelines --- .github/CODEOWNERS | 8 +++++++ .gitignore | 16 +++++++++++++- CONTRIBUTING.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 .github/CODEOWNERS create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..79d9565 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,8 @@ +# These owners will be the default owners for everything in the repo +* @jagnd1 + +# Specific file protections +*.py @jagnd1 +*.js @jagnd1 +*.ts @jagnd1 +*.sol @jagnd1 diff --git a/.gitignore b/.gitignore index 3585ff8..f855d23 100644 --- a/.gitignore +++ b/.gitignore @@ -67,4 +67,18 @@ Thumbs.db # Temporary files *.tmp -*.temp \ No newline at end of file +*.temp + +# Node +node_modules/ +npm-debug.log +yarn-error.log + +# Environment +.env.local +*.key +*.pem + +# Crypto sensitive +private_keys/ +wallets/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..93a0bd8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to FM Crypto Service + +Thank you for your interest in contributing to this project! + +## How to Contribute + +### Reporting Issues + +If you find a bug or have a suggestion: +1. Check if the issue already exists +2. Open a new issue with a clear description +3. Include steps to reproduce (for bugs) + +### Submitting Changes + +1. Fork the repository +2. Create a new branch (`git checkout -b feature/your-feature-name`) +3. Make your changes +4. Test thoroughly +5. Commit with clear messages +6. Push to your fork +7. Submit a Pull Request + +## Pull Request Guidelines + +- Describe what your PR does and why +- Reference any related issues +- Ensure code follows existing style +- Update documentation if needed +- Keep changes focused and atomic + +## Code Standards + +- Python code should follow PEP 8 +- JavaScript/TypeScript should follow ESLint rules +- Add comments for complex logic +- Update README.md for new features +- Maintain compatibility with existing dependencies + +## Security + +- Never commit private keys or sensitive data +- Follow secure coding practices for crypto operations +- Report security vulnerabilities privately + +## License + +By contributing, you agree that your contributions will be licensed under the same license as this project. + +## Questions? + +Open an issue for discussion before starting major changes.