Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (49 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 1.87 KB

Contributing to stommobs

Thank you for your interest in contributing to the stommobs project! We welcome all contributions, whether they are bug reports, feature requests, code improvements, or documentation updates.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top right of the repository page to create your own copy.

  2. Clone Your Fork

    • Clone your fork to your local machine: 
      git clone https://github.com/your-username/stommobs.git

  3. Create a Branch

    • Create a new branch for your feature or fix: 
      git checkout -b my-feature

  4. Make Your Changes

    • Write clear, concise code and include tests or examples where appropriate.
    • Follow the existing code style and conventions.

  5. Test Your Changes

    • Ensure your changes build and pass all tests: 
      ./gradlew build
    • For local server testing: 
      ./gradlew runTestServer

  6. Commit and Push

    • Commit your changes with a descriptive message: 
      git commit -am "Add my feature"
git push origin my-feature

  7. Open a Pull Request

    • Go to the GitHub page for your fork and click "Compare & pull request".
    • Describe your changes and reference any related issues.

Code of Conduct

Please be respectful and considerate in all interactions. See CODE_OF_CONDUCT.md if available.

Reporting Issues

  • Use the GitHub Issues tab to report bugs or request features.
  • Provide as much detail as possible, including steps to reproduce and relevant logs or screenshots.

Style Guide

  • Use idiomatic Kotlin and Java.
  • Write clear, maintainable code and documentation.
  • Keep pull requests focused and minimal.

Questions?

Open an issue or start a discussion in the repository.

Thank you for helping make stommobs better!