Contributing Guide¶
Guidelines for contributing to the Authentication Test API project.
Getting Started¶
- Fork the repository
- Clone your fork
- Create a feature branch
- Make your changes
- Submit a pull request
Development Setup¶
# Clone repository
git clone https://github.com/yourusername/authentication_test.git
cd authentication_test
# Build project
mvn clean package
# Run in development mode
mvn liberty:dev
Code Style¶
- Follow Java naming conventions
- Use meaningful variable names
- Add JavaDoc comments for public methods
- Keep methods focused and concise
Testing¶
- Write unit tests for new features
- Ensure all tests pass before submitting PR
- Aim for 80%+ code coverage
Documentation¶
- Update documentation for new features
- Keep README.md current
- Add examples for new endpoints
Pull Request Process¶
- Update documentation
- Add tests for new features
- Ensure build passes
- Request review from maintainers