CONTRIBUTION.md 4.68 KB
Newer Older
Sameer's avatar
Sameer committed
1 2 3 4
**WELCOME**

We love your input! We want you to contribute to this project , whether it's:

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


T.Sri sowmya's avatar
T.Sri sowmya committed
11
**Contributing:**
Sameer's avatar
Sameer committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

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.


**TECHNOLOGIES USED:**

*  We've used PYTHON (v. 3.7.3),HTML , CSS , javascript.
NODEJS for backend and MongoDB database


**MODULES  USED:**


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.


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.


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


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.


CUFFLINKS:
Cufflinks, a library for easy interactive Pandas charting with Plotly. Cufflinks binds Plotly directly to pandas dataframes.

T.Sri sowmya's avatar
T.Sri sowmya committed
45
**Merge Request Process:**
Sameer's avatar
Sameer committed
46 47 48 49 50

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.
 
T.Sri sowmya's avatar
T.Sri sowmya committed
51
**Code of Conduct:**
Sameer's avatar
Sameer committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69


Acceptable Behaviour:

* 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.

Unacceptable Behaviour:

* 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.

T.Sri sowmya's avatar
T.Sri sowmya committed
70
**Enforcement:**
Sameer's avatar
Sameer committed
71 72 73 74 75 76

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.

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.


T.Sri sowmya's avatar
T.Sri sowmya committed
77
**Scope:**
Sameer's avatar
Sameer committed
78 79 80

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.

T.Sri sowmya's avatar
T.Sri sowmya committed
81
**Our Responsibilities:**
Sameer's avatar
Sameer committed
82 83 84 85 86 87

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.

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.


T.Sri sowmya's avatar
T.Sri sowmya committed
88
**BUG REPORT:**
Sameer's avatar
Sameer committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109


Please use GitLab issues to track public bugs.
Please Follow the following instructions while reporting a bug.


*  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