2.9 KiB
Contributing Guidelines
Thank you for your interest in contributing to BastionGuard.
This document defines the rules and procedures required to ensure high standards of quality, security, and consistency within the project.
General Requirements
All contributors must:
- Comply with the Code of Conduct
- Accept the GPLv3 license
- Follow the Security Policy
- Respect this document
Contributions that do not meet these requirements may be rejected without further notice.
Types of Contributions
The following types of contributions are welcome:
- Bug fixes
- Performance improvements
- Approved new features
- Documentation enhancements
- Automated tests
- Security reviews and audits
The following contributions are not accepted:
- Offensive or malicious functionality
- Code intended for illegal activities
- Security bypass mechanisms
- Violations of third-party rights
- Obfuscated or intentionally misleading code
Contribution Process
1. Issue Reporting
Before submitting major changes, contributors should:
- Search for existing issues
- Open a new issue describing the proposal
- Wait for maintainer feedback when required
2. Fork and Branch
Contributors must:
- Fork the official repository
- Create a dedicated branch for each change
- Use descriptive branch names
Example:
3. Development Standards
All code contributions must:
- Follow the project's coding style
- Include appropriate documentation
- Provide unit and integration tests where applicable
- Avoid introducing breaking changes without approval
- Maintain backward compatibility when possible
4. Security Requirements
Contributors must:
- Follow secure coding practices
- Avoid hardcoded credentials or secrets
- Prevent introduction of known vulnerabilities
- Report discovered security issues privately
Security-related changes may be subject to additional review.
5. Commit and Pull Request Rules
Commits must:
- Be atomic and focused
- Include clear and descriptive messages
- Reference relevant issues
Pull Requests must:
- Describe the purpose and scope of changes
- Pass all automated checks
- Address reviewer feedback
- Not include unrelated modifications
6. Review and Approval
All contributions are subject to review by maintainers.
Approval requires:
- Technical correctness
- Security compliance
- Alignment with project goals
- Documentation completeness
Maintainers reserve the right to request changes or reject submissions.
7. Licensing
By submitting a contribution, you confirm that:
- You have the right to submit the code
- Your contribution is licensed under GPLv3
- You grant the project the right to redistribute it
Contributions violating licensing terms will be rejected.
Code of Conduct
All contributors must follow the Code of Conduct. Violations may result in suspension or permanent exclusion.
Contact
For questions related to contributions: