CONTRIBUTION.md 4.68 KB
Newer Older
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
1
2
**WELCOME**

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
3
4
We love your input! We want you to contribute to this project , whether it's:

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
5
6
7
8
9
10
11
* Reporting a bug
* Discussing the current state of the code
* Submitting a fix
* Proposing new features


**Contributing:**
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
12
13
14

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
15
16
17
18

**TECHNOLOGIES USED:**

*  We've used PYTHON (v. 3.7.3),HTML , CSS , javascript.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
19
20
NODEJS for backend and MongoDB database

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
21
22
23
24

**MODULES  USED:**


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
25
26
PANDAS:
Pandas is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
27
28


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
29
30
31
NUMPY:
NumPy is a general-purpose array-processing package. It provides a high-performance multidimensional array object, and tools for working with these arrays.
It is the fundamental package for scientific computing with Python.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
32
33


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
34
35
OSM:
OpenStreetMap (OSM) is a collaborative project to create a free editable map of the world. Rather than the map itself, the data generated by the project is considered its primary output. The creation and growth of OSM has been motivated by restrictions on use or availability of map information across much of the world, and the advent of inexpensive portable satellite navigation devices
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
36
37


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
38
39
NOMINATIM:
Nominatim is a search engine for OpenStreetMap data. This is the debugging interface. You may search for a name or address (forward search) or look up data by its geographic coordinate (reverse search). Each result comes with a link to a details page where you can inspect what data about the object is saved in the database and investigate how the address of the object has been computed.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
40
41


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
42
43
CUFFLINKS:
Cufflinks, a library for easy interactive Pandas charting with Plotly. Cufflinks binds Plotly directly to pandas dataframes.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
44
45
46

**Merge Request Process:**

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
47
48
49
Update the README.md with details of changes to the interface.
Increase the version numbers in any examples files and the README.md to the new version that this Merge Request would represent.
One of the Maintainers will verify the changes you make and if they are valid and useful, your request will be merged.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
50
51
52
53
 
**Code of Conduct:**


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
54
55
Acceptable Behaviour:

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
56
57
58
59
60
* Using welcoming and inclusive language.
* Being respectful of differing viewpoints and experiences.
* Gracefully accepting constructive criticism.
* Focusing on what is best for the community.
* Showing empathy towards other community members.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
61
62
63

Unacceptable Behaviour:

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
64
65
66
67
68
69
70
* Discrimination based on Sex, Race , Religion, Caste, Nationality.
* Trolling, insulting/derogatory comments, and personal or political attacks.
* Public or private harassment.
* Publishing others' private information, such as a physical or electronic address, without explicit permission.
* Other conduct which could reasonably be considered inappropriate in a professional setting.

**Enforcement:**
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
71
72

Instances of abusive, harassing, or otherwise unacceptable behavior should be reported to the maintainers. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
73

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
74
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
75
76
77
78


**Scope:**

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
79
When an individual is representing the project or its community, he/she must use a valid e-mail address or social media account . Representation of a project may be further defined and clarified by project maintainers.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
80
81
82

**Our Responsibilities:**

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
83
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
84

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
85
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
86
87
88
89
90


**BUG REPORT:**


Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
91
92
93
Please use GitLab issues to track public bugs.
Please Follow the following instructions while reporting a bug.

Srilekha Mopidevi's avatar
Srilekha Mopidevi committed
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

*  A quick summary and/or background
*   Steps to reproduce the bug
*   Give sample code if you can.
*   What you expected would happen
*   What actually happens
*   Notes


**TEAM INTRODUCTION**
* K. SAMEER KOUSIK
* K. SRIKANTH
* C. SRAVANI
* R. REVANTH
* T. SRI SOWMYA
* Y. ANUSHA