#Contributing to BeFriend
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to BeFriend on GitHub These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to prajjwaldimri@outlook.com.
BeFriend is an multi-platform distress signal sending application which enforces maximum possible security for a user while in time of danger. Friend's currently support Android and Windows. Other platforms will be added in future.
This section guides you through submitting a bug report for Friend's. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.
- Please note Windows 10 Mobile is currently not fully stable hence it contains bugs that are in the system. Thus the system could exhibit unusual behavior which includes sudden closing of app and app not starting. In these cases please restart your phone first to see if the app still displays the behavior. **
- Determine which repository the problem should be reported in.
- Perform a search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
This section guides you through submitting an enhancement suggestion for BeFriend, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
When you are creating an enhancement suggestion, please include as many details as possible.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of BeFriend which the suggestion is related to. You can use this tool to record GIFs on OSX and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful
- Specify the name and version of the OS you're using. (Currently Android/Windows)
//TODO: Explain MVVM Pattern here