Skip to content

Latest commit

 

History

History
126 lines (87 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

126 lines (87 loc) · 2.68 KB
Raw

Contributing to khode-two-factor-auth

Thank you for your interest in contributing to Khode Two-Factor Auth! This extension aims to enhance Keycloak's Two-Factor Authentication capabilities, and we welcome contributions from the community.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork:
git clone https://github.com/your-username/khode-two-factor-auth.git
cd khode-two-factor-auth

Development Setup

  1. Ensure you have the following prerequisites:

    • Java Development Kit (JDK)
    • Maven
    • Keycloak server (for testing)

  2. Build the project:

mvn clean package
  1. Deploy to Keycloak for testing:
cp target/khode-two-factor-auth.jar /path/to/keycloak/standalone/deployments/

Making Changes

  1. Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name

  1. Make your changes

  2. Test thoroughly:

    • Ensure all endpoints work as expected
    • Test error scenarios
    • Verify authentication and authorization

  3. Commit your changes:

git add .
git commit -m "Add a descriptive commit message"
  1. Push to your fork:
git push origin feature/your-feature-name
  1. Open a Pull Request from your fork to our main branch

Pull Request Guidelines

  • Focus on a single feature or fix per PR
  • Update documentation for any changed functionality
  • Follow existing code style and patterns
  • Include tests for new features
  • Ensure all tests pass before submitting
  • Update the README.md if necessary

Areas for Contribution

We welcome contributions in these areas:

  • Additional TOTP management features
  • Enhanced security measures
  • Performance improvements
  • Documentation improvements
  • Bug fixes
  • Test coverage improvements

Bug Reports

When filing an issue, please include:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Your environment:
    • Keycloak version
    • Java version
    • Operating system
  • Relevant logs or error messages

Feature Requests

We welcome feature requests! Please provide:

  • Clear description of the proposed feature
  • Use cases and benefits
  • Any implementation ideas
  • Potential impact on existing functionality

Questions?

Feel free to open an issue for any questions about:

  • Setting up the development environment
  • Implementation details
  • Best practices
  • Feature discussions

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.

Contact

For any questions or concerns, please:

Thank you for contributing to khode-two-factor-auth!