Feat: Add docs

CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Jadhav"
+  given-names: "Kaushik"
+orcid: "https://orcid.org/0000-0000-0000-0000"
+title: "Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis"
+version: 2.0.0
+doi: 10.5281/zenodo.10498988
+date-released: 2023-03-29
+url: "https://github.com/kaushikjadhav01/Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis"

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected] / [email protected]
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+**Contributors guide**
+
+**How to contribute to the code base**
+
+Install Git
+
+Guide - https://github.com/git-guides/install-git
+
+Install Git GUI
+
+Guide - https://git-scm.com/downloads/guis/
+
+Project Overview - https://github.com/kaushikjadhav01/Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis/blob/main/README.md
+
+**Types of code changes and contributions we accept**
+
+- Minor issue fixes like typos, basic layout changes, etc
+- Resolutions for raised issues, raising a new issue
+- Addition and modifications to existing features provided with proper unit testing and code coverage
+
+**Tips to begin development**
+- Go through the documentation hosted on the GitHub pages website to understand the description of each of the classes and the hierarchy of inheritance.
+- Setup the tools for development and a virtual device for quick testing.
+- Familiarize yourself with android implementation tests for quick validation of any changes. [Getting started with Android implementation tests](https://developer.android.com/training/testing/fundamentals)
+- You can also read up on Firebase to get a better understanding of the Firebase platform and the Android SDK. [Getting started with Firebase & Android SDK](https://firebase.google.com/docs/android/setup)
+
+**Sample Workflow**
+- Install Git and Android Studio on your machine.
+- Clone the repo to the machine.
+- Open the project in Android Studio and configure Gradle plugins and build scripts by running Build in Android Studio.
+- Once the build is successful, open the Android device manager and install a virtual device (you can also use a physical device in case the machine is low on memory by using wireless debugging).
+- Run the application in the newly created/ connected device.
+- Create a new account in Firebase by following the sign-up process in the application.
+- After updating the repository with latest version of 'main', fork a new branch to contain the new changes.
+- Proceed to build the feature and use the 'deploy' the button at the top to flash the latest code to the device.
+- Commit frequently to ensure that the changes are small and reversible in case of an issue.
+- Once the feature is built, make sure that the new changes are commented appropriately for the documentation to be generated correctly for any new methods and classes.
+- Also add appropriate tests to ensure that the newly added parts are continuously validated.
+- From the build options dropdown in Android Studio pick the task 'generateDocsForDebug' or 'generateDocsForRelease' to generate updated documentation.
+- Commit the documentation changes and push to remote.
+- All the automated tasks will begin to run, monitor the progress and fix any failures which show up.
+- Request a review from one of the maintainers and get an approval.
+- The changes will now be merged.
+
+**Branching Strategy**
+
+- Create a feature branch or a bug branch from the dev branch
+- Branch naming conventions : 
+     - Adding a new feature to the existing code base: feature/--implementiation name--
+     - Resolving a bug or an issue: bug/--fix name--
+- Commit your code to the feature branch and raise a Pull Request to the dev branch.
+- No commits should be added to the main branch from a feature branch, only the dev branch can add commits to the main.
+- Please ensure all style checkers and validation steps are passing before requesting for review.
+
+**Raising a PR and approvals**
+
+- Raise a PR from the feature branch to the dev branch and request for review from the repository owners
+- 2 mandatory reviews are required before merging
+- Follow clean code and fix the PR comments before merging PR
+- A release will be triggered every time the code is merged to the main branch, only the dev branch should be merged to the main 
+
+**Allowed actions**
+
+- Watching repo
+- Forking repo
+- Contributing to the repo
+- Cloning and making changes
+- Raising issues
+- Fixing bugs

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kaushik Jadhav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.