nearby_service/CONTRIBUTING.md at main

Files

T

Kseniia Nikitina 7049c39cf0 BREAKING CHANGE: Update API for connection, communication channel state and is browser value (#14 )

* refactor(lib, example, example_full): use streams for communication channel and is ios browser

* feat: add abstract toJson() to message

* refactor: add deprecations for nearby_service

* feat(example): update main.dart

* feat(nearby_service): add comments

* feat(nearby_service_platform_interface): add deprecation to getConnectedDeviceStream

* feat(nearby_service/message): add concrete implementation for toJson()

* feat(nearby_service/android): add deprecations

* fix(nearby_service/android): reset check for android device

* fix(nearby_service/ios): change ios service to deprecations variant

* chore(nearby_service): edit deprecation messages

* chore: update gitignore

* doc: add CONTRIBUTING file

* doc: update CONTRIBUTING file

* chore: update CONTRIBUTING.md

* chore: update CONTRIBUTING.md

* chore: version 0.1.0

* fix(example_full): move startListeningCommunicationChannelState() upper

2024-08-18 15:42:53 +02:00

3.6 KiB

Raw Permalink Blame History

Contributing to Nearby Service

Thank you for considering contributing to the Nearby Service package! Please follow the guidelines below based on your use case.

Reporting a bug

If you have found a bug, please follow these steps:

Search for existing issues: Before opening a new issue, please check the Issues to see if the bug has already been reported.
Open a new Bug Report issue: If the bug has not been reported yet, open a new issue here and use template Bug Report to indicate that this is a bug report.
Provide details: Include a clear and concise description of the bug, steps to reproduce it, and any relevant logs or screenshots.

Suggesting an improvement or feature

If you have an idea for an improvement or a new feature, follow these steps:

Search for existing issues: Check the Issues to see if your suggestion has already been made.
Open a new Feature Request issue: If not, open a new issue here and use template Feature Request to indicate that this is a suggestion for improvement.
Describe your suggestion: Provide a detailed description of the improvement or feature, including potential use cases and any other relevant information.

Submitting a bug fix or improvement

If you have created a fix for a bug or an improvement, please follow these steps:

Search for existing issues: Ensure the issue has not already been fixed or the improvement has not been implemented by checking the Issues.
Fork the repository: Fork the Nearby Service repository to your own GitHub account.
Create a new branch: In your forked repository, create a new branch for your fix or improvement.
Implement your fix or improvement: Make your changes in the new branch.
Open a Pull Request: Once your changes are complete, open a Pull Request (PR) from your forked repository’s branch to the main branch of the original repository.
Fill in the PR template: In your PR, fill in the PR template with the appropriate information.

Asking a question about nearby_service or source code

If you have a question about how to use Nearby Service or about the source code, please follow these steps:

Search for existing questions: Check the Issues to see if your question has already been answered.
Open a new Question issue: If your question has not been addressed, open a new issue here and use one of Question templates to indicate that this is a question.
Describe your question: Clearly state your question and provide any necessary context.

Your effort is appreciated 💗