CalvinBackup/phishingclub
1
0
Fork 0
mirror of https://github.com/phishingclub/phishingclub.git synced 2026-02-12 16:12:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

split readme into github parts

Browse Source 
Signed-off-by: Ronni Skansing <rskansing@gmail.com>
This commit is contained in:
Ronni Skansing
2025-08-22 12:05:49 +02:00
parent 144a5fb1d6
commit c0269ff4b4
4 changed files with 141 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,84 @@
# Contributing to Phishing Club
We welcome contributions from the community! Please follow these guidelines to ensure a smooth contribution process.
## Before Contributing
1. **Check existing issues** - Search for existing feature requests or bug reports
2. **Create a feature request** - If your idea doesn't exist, create a detailed feature request issue. We have criteria for which features we want to add.
3. **Wait for approval** - Allow us to review and approve your proposal
4. **Discuss implementation** - We may suggest changes or alternative approaches
## Development Workflow
1. **Fork the repository** and clone your fork
2. **Create a feature branch** from `main`:
```bash
git checkout -b feat/your-feature-name
```
3. **Follow naming conventions**:
- Features: `feat/feature-name`
- Bug fixes: `fix/bug-description`
- Documentation: `docs/update-description`
- Refactoring: `refactor/component-name`
4. **Follow conventions**:
- Follow existing code style and patterns
- Update documentation as needed
- Add tests when possible
5. **Prepare for submission**:
- **Rebase your commits** to a single, clean commit before creating the pull request
- **Sign your commit** using the `-s` flag: `git commit -s -m "Your commit message"`
- Ensure your commit message is clear and descriptive
6. **Submit a pull request**:
- Reference the related issue number
- Provide a clear description of changes
## Code Standards
- **Formatting**: Use project configurations
- **Documentation**: Update relevant docs with your changes
- **Security**: Follow secure coding practices
## License Agreement
**Important**: All contributors must agree to our Contributor License Agreement (CLA).
By contributing to Phishing Club, you agree that your contributions will be licensed under the same dual license terms (AGPL-3.0 and commercial). You confirm that:
- You have the right to contribute the code
- Your contributions are your original work or properly attributed
- You grant Phishing Club the right to license your contributions under both AGPL-3.0 and commercial licenses
## Required Commit Practices
**All commits must be signed off** using the `-s` flag: `git commit -s -m "Your commit message"`
**Before submitting a pull request**, rebase your branch to a single commit:
```bash
# Example workflow to squash commits:
git rebase -i main # Interactive rebase to squash commits
git commit --amend -s # Add sign-off to the final commit if needed
```
This adds a "Signed-off-by" line indicating you agree to our [CLA](CLA.md) and the [Developer Certificate of Origin](https://developercertificate.org/).
Use descriptive commit messages that explain what and why, not just what.
## Development Resources
For detailed terms and additional information, see:
- [Contributor License Agreement (CLA.md)](CLA.md)
- [Contributors Guide (CONTRIBUTORS.md)](CONTRIBUTORS.md)
- [Security Policy (SECURITY.md)](SECURITY.md)
## Getting Help
- **General Questions**: Join our [Discord community](https://discord.gg/Zssps7U8gX)
- **Development Help**: Open a GitHub discussion or issue
- **Feature Discussions**: Create a feature request issue first
Thank you for contributing to Phishing Club!

76
CONTRIBUTORS.md
View File

@@ -4,77 +4,19 @@ This file acknowledges the individuals and organizations who have contributed to
## How to Contribute ## How to Contribute
We welcome contributions from the community! Before contributing, please: Want to contribute? Please read our [Contributing Guidelines](CONTRIBUTING.md) for detailed information.
1. Read our [Contributing Guidelines](README.md#contributing) ## Contributors
2. Sign our Contributor License Agreement (see below)
3. Follow our development workflow and coding standards
## Contributor License Agreement (CLA) *Thank you to everyone who has contributed to Phishing Club:*
**Important**: By contributing to Phishing Club, you agree to the following terms: **Contributors add yourself here**
### Grant of Rights
You hereby grant to Phishing Club and to recipients of software distributed by Phishing Club a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable license to:
- Use, reproduce, modify, display, perform, sublicense, and distribute your contributions
- License your contributions under both the AGPL-3.0 license and commercial licenses
### Representations
You represent that:
- You have the legal right to grant the above licenses
- Your contributions are your original creation or you have sufficient rights to grant the licenses
- Your contributions do not violate any third-party rights
- You understand and agree that your contributions may be licensed under both open source and commercial terms
### Developer Certificate of Origin (DCO)
All commits must include a "Signed-off-by" line to indicate agreement with the [Developer Certificate of Origin](https://developercertificate.org/):
```
git commit -s -m "Your commit message"
```
This adds a line like:
```
Signed-off-by: Your Name <your.email@example.com>
```
By adding this line, you certify that you have the right to contribute the code and agree to our CLA terms.
## Recognition
Contributors will be recognized in the following ways:
- Listed in this file (with permission)
- GitHub contributor statistics
## Types of Contributions
Phishing Club has a lots of room for improvement, both in maintaince and in features that can be implemented. Much of the code can be refactored and improved in various ways.
Join our discord and we can help you if you want a specific project.
Be mindful that all contributions should strive to be secure and work with the
live update system.
We appreciate all forms of contribution:
- 🐛 Bug reports and fixes
- ✨ New features and enhancements
- 📖 Documentation improvements
- 🧪 Test coverage improvements
- 🎨 UI/UX improvements
- 🔒 Security improvements
- 🌍 Translations and internationalization
- 💡 Ideas and feature suggestions
## Contact
For questions about contributing or the CLA:
- Create a GitHub issue
- Join our [Discord community](https://discord.gg/Zssps7U8gX)
- Email: contribute@phishing.club
--- ---
*Thank you to all contributors who help make Phishing Club better!* 🙏 ## Contact
# CONTRIBUTORS For questions about contributing:
**contributors add yourself here** - Create a GitHub issue
- Join our [Discord community](https://discord.gg/Zssps7U8gX)
- Read our [Contributing Guidelines](CONTRIBUTING.md)

102
README.md
View File

@@ -192,91 +192,41 @@ For organizations that want to:
## Contributing ## Contributing
We welcome contributions from the community! Please follow our contribution guidelines: We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) for detailed information on:
### Before Contributing - Development setup and workflow
- Code standards and conventions
- Submission requirements
- License agreements
1. **Check existing issues** - Search for existing feature requests or bug reports **Quick Start for Contributors:**
2. **Create a feature request** - If your idea doesn't exist, create a detailed feature request issue, we have criteria for which features we want to add and do not waste anyones time with feature requests we never wanted. 1. Check existing issues and create a feature request if needed
3. **Wait for approval** - Allow us to review and approve your proposal 2. Wait for approval before starting work
4. **Discuss implementation** - We may suggest changes or alternative approaches 3. Fork the repository and create a feature branch
4. Follow our development workflow and coding standards
5. Submit a pull request with signed commits
### Development Workflow For complete details, see [CONTRIBUTING.md](CONTRIBUTING.md).
1. **Fork the repository** and clone your fork
2. **Create a feature branch** from `main`:
```bash
git checkout -b feat/your-feature-name
```
3. **Follow naming conventions**:
- Features: `feat/feature-name`
- Bug fixes: `fix/bug-description`
- Documentation: `docs/update-description`
- Refactoring: `refactor/component-name`
4. **Follow conventions**:
- Follow existing code style and patterns
- Update documentation as needed
5. **Prepare for submission**:
- **Rebase your commits** to a single, clean commit before creating the pull request
- **Sign your commit** using the `-s` flag: `git commit -s -m "Your commit message"`
- Ensure your commit message is clear and descriptive
6. **Submit a pull request**:
- Reference the related issue number
- Provide a clear description of changes
- Include screenshots/videos for UI changes
### Code Standards
- **Formatting**: Use project configurations
- **Documentation**: Update relevant docs with your changes
- **Security**: Follow secure coding practices
### License Agreement
**Important**: All contributors must agree to our Contributor License Agreement (CLA).
By contributing to Phishing Club, you agree that your contributions will be licensed under the same dual license terms (AGPL-3.0 and commercial). You confirm that:
- You have the right to contribute the code
- Your contributions are your original work or properly attributed
- You grant Phishing Club the right to license your contributions under both AGPL-3.0 and commercial licenses
**Required**:
- All commits must be signed off using the `-s` flag: `git commit -s -m "Your commit message"`
- Before submitting a pull request, rebase your branch to a single commit
- Use descriptive commit messages that explain what and why
```bash
# Example workflow:
git rebase -i main # Interactive rebase against main branch to squash commits
git commit --amend -s # Add sign-off to the final commit if needed
```
This adds a "Signed-off-by" line indicating you agree to our [CLA](CLA.md) and the [Developer Certificate of Origin](https://developercertificate.org/).
For detailed terms, see:
- [Contributor License Agreement (CLA.md)](CLA.md)
- [Contributors Guide (CONTRIBUTORS.md)](CONTRIBUTORS.md)
## Support and Security ## Support
Need help, join the [Phishing Club Discord](https://discord.gg/Zssps7U8gX) Need help? Join the [Phishing Club Discord](https://discord.gg/Zssps7U8gX)
- **Security Issues**: Report privately via [security@phishing.club](mailto:security@phishing.club)
- **Commercial Licensing**: Contact [license@phishing.club](mailto:license@phishing.club)
- **General Support**: Join our Discord community or open a GitHub issue - **General Support**: Join our Discord community or open a GitHub issue
- **Commercial Licensing**: Contact [license@phishing.club](mailto:license@phishing.club)
- **Security Issues**: See our [Security Policy](SECURITY.md)
## Only for ethical use ## Security and Ethical Use
This platform is designed for authorized security testing only. Users are responsible for: This platform is designed for **authorized security testing only**.
- Obtaining proper authorization before conducting phishing simulations For important information about:
- Complying with all applicable laws and regulations - Reporting security vulnerabilities
- Using the platform ethically and responsibly - Ethical use requirements
- Protecting any data collected during testing - Legal responsibilities
- Security best practices
This tool is for authorized security testing only. Misuse of this software may violate applicable laws. Users are solely responsible for ensuring their use complies with all applicable laws and regulations. Please read our [Security Policy](SECURITY.md).
**Important**: Users are solely responsible for ensuring their use complies with all applicable laws and regulations.

22
SECURITY.md Normal file
View File

@@ -0,0 +1,22 @@
# Security Policy
## Reporting Security Vulnerabilities
We take the security of Phishing Club seriously. If you discover a security vulnerability, please report it responsibly.
### How to Report
**DO NOT** create a public GitHub issue for security vulnerabilities.
Instead, please report security issues privately via email to:
**[security@phishing.club](mailto:security@phishing.club)**
### What to Include
When reporting a security vulnerability, please include:
- A clear description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Any suggested fixes or mitigations
- Your contact information for follow-up