Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (23 loc) · 1010 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1010 Bytes

Contributing

Contributions are welcome. Please read this guide before submitting changes.

Getting started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/wifix2.git
  3. Create a branch: git checkout -b your-feature-name
  4. Build and run: ./gradlew installDebug

Code style

  • Use Kotlin and follow the official Kotlin style guide
  • Prefer functional style; use classes only when necessary
  • Use clear, descriptive variable and function names
  • Keep functions small; extract helpers only when logic is reused

Submitting changes

  1. Ensure the project builds: ./gradlew assembleDebug
  2. Run tests: ./gradlew test
  3. Commit with clear messages
  4. Push to your fork and open a pull request

Pull request guidelines

  • Describe the change and why it is needed
  • Reference any related issues
  • Keep PRs focused; one feature or fix per PR

Questions

Open an issue for questions or discussion.