Skip to content

Commit 3a0eadb

Browse files
kaushikjadhav01kaushikjadhav01
committed
Feat: Add docs
1 parent ac02f03 commit 3a0eadb

File tree

5 files changed

+333
-57
lines changed

5 files changed

+333
-57
lines changed

‎CITATION.cff

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- family-names: "Jadhav"
5+
given-names: "Kaushik"
6+
orcid: "https://orcid.org/0000-0000-0000-0000"
7+
title: "Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis"
8+
version: 2.0.0
9+
doi: 10.5281/zenodo.10498988
10+
date-released: 2023-03-29
11+
url: "https://github.com/kaushikjadhav01/Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis"

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
kajadhav@ncsu.edu / kaushikjadhav293@gmail.com
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
**Contributors guide**
2+
3+
**How to contribute to the code base**
4+
5+
Install Git
6+
7+
Guide - https://github.com/git-guides/install-git
8+
9+
Install Git GUI
10+
11+
Guide - https://git-scm.com/downloads/guis/
12+
13+
Project Overview - https://github.com/kaushikjadhav01/Stock-Market-Prediction-Web-App-using-Machine-Learning-And-Sentiment-Analysis/blob/main/README.md
14+
15+
**Types of code changes and contributions we accept**
16+
17+
- Minor issue fixes like typos, basic layout changes, etc
18+
- Resolutions for raised issues, raising a new issue
19+
- Addition and modifications to existing features provided with proper unit testing and code coverage
20+
21+
**Tips to begin development**
22+
- Go through the documentation hosted on the GitHub pages website to understand the description of each of the classes and the hierarchy of inheritance.
23+
- Setup the tools for development and a virtual device for quick testing.
24+
- 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)
25+
- 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)
26+
27+
**Sample Workflow**
28+
- Install Git and Android Studio on your machine.
29+
- Clone the repo to the machine.
30+
- Open the project in Android Studio and configure Gradle plugins and build scripts by running Build in Android Studio.
31+
- 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).
32+
- Run the application in the newly created/ connected device.
33+
- Create a new account in Firebase by following the sign-up process in the application.
34+
- After updating the repository with latest version of 'main', fork a new branch to contain the new changes.
35+
- Proceed to build the feature and use the 'deploy' the button at the top to flash the latest code to the device.
36+
- Commit frequently to ensure that the changes are small and reversible in case of an issue.
37+
- 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.
38+
- Also add appropriate tests to ensure that the newly added parts are continuously validated.
39+
- From the build options dropdown in Android Studio pick the task 'generateDocsForDebug' or 'generateDocsForRelease' to generate updated documentation.
40+
- Commit the documentation changes and push to remote.
41+
- All the automated tasks will begin to run, monitor the progress and fix any failures which show up.
42+
- Request a review from one of the maintainers and get an approval.
43+
- The changes will now be merged.
44+
45+
**Branching Strategy**
46+
47+
- Create a feature branch or a bug branch from the dev branch
48+
- Branch naming conventions :
49+
- Adding a new feature to the existing code base: feature/--implementiation name--
50+
- Resolving a bug or an issue: bug/--fix name--
51+
- Commit your code to the feature branch and raise a Pull Request to the dev branch.
52+
- No commits should be added to the main branch from a feature branch, only the dev branch can add commits to the main.
53+
- Please ensure all style checkers and validation steps are passing before requesting for review.
54+
55+
**Raising a PR and approvals**
56+
57+
- Raise a PR from the feature branch to the dev branch and request for review from the repository owners
58+
- 2 mandatory reviews are required before merging
59+
- Follow clean code and fix the PR comments before merging PR
60+
- 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
61+
62+
**Allowed actions**
63+
64+
- Watching repo
65+
- Forking repo
66+
- Contributing to the repo
67+
- Cloning and making changes
68+
- Raising issues
69+
- Fixing bugs

‎LICENSE

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

0 commit comments

Comments
 (0)