Thank you for your interest in contributing to GitHub Users! This document provides guidelines and instructions for contributing.
If you find a bug, please create an issue with:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected vs actual behavior
- iOS version and device information
- Screenshots if applicable
Feature suggestions are welcome! Please create an issue with:
- A clear description of the feature
- Use cases and benefits
- Any mockups or examples if applicable
- Fork the repository and create your branch from
main - Make your changes following the project's code style
- Write or update tests if applicable
- Update documentation if needed
- Ensure all tests pass before submitting
- Create a pull request with a clear description
- Follow Swift API Design Guidelines
- Use SwiftUI best practices
- Maintain Clean Architecture principles
- Write self-documenting code with clear naming
- Add comments for complex logic
- Keep functions focused and small
- Write unit tests for ViewModels and Services
- Test edge cases and error scenarios
- Ensure test coverage doesn't decrease
Use clear, descriptive commit messages:
- Use present tense ("Add feature" not "Added feature")
- Start with a capital letter
- Reference issue numbers when applicable
Before submitting a pull request:
- Code follows the project's style guidelines
- Tests pass locally
- Documentation is updated
- No new warnings or errors
- Changes are tested on iOS 15.0+
Thank you for contributing! 🎉